與Mybatis整合：從原理到實踐，徹底搞懂IoC與事務管理)
簡介這是一份面向Java開發(fā)學習者的SSM框架入門課件聚焦Spring注解開發(fā)與Spring整合MyBatis兩大主題適合正在學習Spring核心容器、依賴注入及持久層框架整合的讀者。講解脈絡清晰從IoC/DI基本思想、BeanFactory與ApplicationContext容器層次到注解定義bean、純注解開發(fā)、第三方bean管理和依賴注入再延伸到Spring整合MyBatis與JUnit層層遞進便于系統(tǒng)建立SSM整合知識框架。壓縮包內(nèi)共1個pptx文件約2.99MB彩色排版通過結(jié)構(gòu)圖、示例代碼和XML配置對照展示知識點既可用作課堂同步講義也可作為考前復習提綱。目前已有181人學習使用內(nèi)容覆蓋Spring概述、核心容器總結(jié)、注解開發(fā)、整合MyBatis與JUnit等章節(jié)適合希望快速掌握Spring注解風格開發(fā)和SSM整合配置的初學者進階參考。 看到這個標題我就知道這應該是不少Java開發(fā)入行時都會遇到的一份PPT——講注解開發(fā)也講SSM里最核心的Spring和Mybatis整合。老實說這類材料網(wǎng)上多得是但絕大多數(shù)要么只貼代碼不講為什么要么上來就甩配置把人看懵。這篇我就以做過的項目經(jīng)驗為底把注解開發(fā)和兩者整合這條線從頭捋一遍不光是能用還得讓你知道它是怎么跑起來的。1. Spring注解開發(fā)的核心思路從XML到注解到底省了什么1.1 為什么注解能取代一堆XML配置早些年做Spring項目光一個applicationContext.xml就能寫上好幾百行里面全是bean標簽定義一個對象就得寫一段對象多了以后維護成本直接爆炸。后來Spring從2.5開始引入注解到了Spring Boot時代基本全面轉(zhuǎn)向注解和自動配置這背后其實是三層邏輯。第一注解把“定義”和“使用”放在了一起。你在類上寫一個Service這個類就是業(yè)務層組件不用再跑到配置文件里找對應的bean定義。類本身即文檔別人看代碼就知道這個類在容器里扮演什么角色而不是把代碼和配置來回切換。第二注解開發(fā)能大幅減少樣板代碼。比如依賴注入你只要用Autowired聲明一下Spring容器啟動時就會把對應的bean塞進來不需要寫setter注入或構(gòu)造器注入的XML。第三注解讓項目的啟動和構(gòu)建流程更輕尤其在微服務拆分的場景下一個服務一個模塊各自用注解完成裝配互不干擾。但有一點我得提醒你注解不是銀彈。它把配置從XML搬到了代碼里雖然直觀但如果你想全局查一下某個bean被哪些地方引用還是會比搜XML麻煩一點。這也是為什么Spring Boot后來引入了ConfigurationProperties這類配置綁定方式把外部配置和Java對象做映射盡量把容易變的東西留在配置文件里把穩(wěn)定的裝配邏輯留在代碼里。我的理解是注解解決的是“怎么裝配的問題”配置文件解決的是“參數(shù)是什么的問題”兩者要搭配用別走極端。1.2 實操里最高頻的注解組合逐個說透Component系列最基礎Service、Repository、Controller其實都是它的衍生本質(zhì)都是把類注冊成Spring容器中的bean只是語義層面區(qū)分了層次。Autowired是按類型注入Resource是按名稱注入這倆面試經(jīng)常會問實際開發(fā)里如果你的容器里只有一個實現(xiàn)類兩者用起來沒區(qū)別一旦有多個實現(xiàn)Autowired需要配合Qualifier指定名字Resource自己就能指定name屬性。我個人的習慣是能用一個實現(xiàn)類就直接Autowired有多實現(xiàn)時優(yōu)先Resource(name xxx)寫起來短也不容易出錯。Configuration和Bean是用來定義配置類的簡單說就是讓你用Java代碼代替XML里的bean定義。比如你要注入一個第三方庫的對象沒法在類上直接加Component那就在配置類里寫一個方法方法上標注Bean方法的返回值就是容器里注冊的對象。這個方法名字默認就是bean名稱也可以顯式指定Bean(name)。ComponentScan負責掃描包路徑Spring Boot里默認掃描啟動類所在包及其子包。這里有個坑有時候你把新寫的Service放在啟動類包外面的目錄里結(jié)果啟動報了NoSuchBeanDefinitionException多半就是掃描路徑?jīng)]覆蓋到。處理方式要么調(diào)整包結(jié)構(gòu)要么在啟動類上顯式加上ComponentScan(basePackages com.xxx)。還有一個容易被忽略的是Scope默認單例這個對于絕大多數(shù)場景沒問題但你在多線程環(huán)境下往類成員變量里塞狀態(tài)就要小心了。單例bean在多線程下是共享的成員變量容易出并發(fā)問題。需要原型作用域時在Bean或Component上標注Scope(prototype)即可。說實話我工作這些年用到prototype的次數(shù)很少大多數(shù)情況都是把無狀態(tài)的服務類設計成單例有狀態(tài)的數(shù)據(jù)往方法參數(shù)和數(shù)據(jù)庫里放。Value用來注入配置文件里的值PropertySource指定外部配置文件位置比如PropertySource(classpath:jdbc.properties)。Value(${jdbc.url})這樣就能讀出來但這個方案在字段多的時候很啰嗦Spring Boot時代基本被ConfigurationProperties取代了。1.3 注解開發(fā)的底層邏輯Bean生命周期是怎么回事很多人面試被問到Spring三級緩存其實這玩意兒跟注解開發(fā)也有關(guān)系。Spring IoC容器啟動的時候會先掃描所有加了注解的類生成BeanDefinition然后按照依賴關(guān)系實例化bean。實例化并不等于初始化完成Spring把對象創(chuàng)建分成了好幾步。三級緩存解決的是循環(huán)依賴問題比如A依賴B、B依賴A沒有三級緩存的話兩個對象互相引用就會死鎖。一級緩存是成品對象二級緩存是早期暴露的半成品三級緩存放的是對象工廠。注解注入基本都是在對象創(chuàng)建完成后通過后置處理器來完成的。我在實際工作中直接遇到循環(huán)依賴的次數(shù)不多但確實有一次加了Transactional后發(fā)現(xiàn)啟動報錯定位下來是A依賴B、B又依賴A當時就把其中一個依賴改成Lazy延遲加載解決了。后來我換了個思路直接從設計上把循環(huán)依賴干掉該拆的方法拆出去該抽的類抽出來反而代碼結(jié)構(gòu)更清爽。所以我的建議是三級緩存這東西面試要知道但工程項目里碰到循環(huán)依賴優(yōu)先想怎么重構(gòu)而不是依賴緩存機制硬扛。2. Spring與Mybatis整合為什么要整合以及整合時發(fā)生了什么2.1 原生Mybatis的痛點與整合思路Mybatis本身是個半自動ORM框架SQL由你控制執(zhí)行結(jié)果自動映射成Java對象靈活性很高。但如果你不用Spring就得自己手動創(chuàng)建SqlSessionFactory自己管理SqlSession每個Mapper接口還得手動寫實現(xiàn)類去調(diào)用SqlSession的方法或者用Mybatis官方提供的Mapper動態(tài)代理。這在簡單項目里還能接受項目一復雜就是災難。真正接手一個項目后你會發(fā)現(xiàn)純Mybatis的使用方式有四個致命傷第一SqlSession線程不安全你不能把它定義為單例每個線程都要獨立的SqlSession第二事務控制全靠自己寫commit/rollback稍不留神就出現(xiàn)數(shù)據(jù)不一致第三Mapper的獲取和生命周期管理非常繁瑣每個業(yè)務代碼里都得寫“獲取session、調(diào)用mapper、關(guān)閉session”的樣板代碼第四跟Spring的聲明式事務Transactional沒法直接集成事務邊界只能靠人肉維護。所以Spring與Mybatis整合本質(zhì)就是讓Spring容器接管Mybatis的核心對象。SqlSessionFactory被定義成單例SqlSession的生命周期交給Spring的SqlSessionTemplate統(tǒng)一管理事務交給Spring的TransactionManager統(tǒng)一處理Mapper接口的代理生成也交給Spring掃描注冊。你這邊的開發(fā)就只需要定義一個接口加幾個注解或者寫個XML映射文件方法調(diào)用時自動拿到代理對象去執(zhí)行SQL。2.2 SqlSessionFactoryBean和MapperScan是怎么回事你用Spring Boot的時候一般只需要在啟動類上加MapperScan(com.xxx.mapper)然后Mybatis的配置類就自動干了一堆活。但如果你理解了底層無非就是幾件事。首先SqlSessionFactoryBean實現(xiàn)了Spring的FactoryBean接口它的作用是把Mybatis的SqlSessionFactory創(chuàng)建過程封裝起來交給Spring容器管理。這里面會讀取Mybatis全局配置注冊typeAliases、typeHandlers、Mapper XML映射文件的位置等。只有這個factory創(chuàng)建好了后續(xù)的Mapper代理才有基礎。其次MapperScan這個注解的作用是掃描指定包下的所有接口把它們注冊成MapperFactoryBean。注意這里不是直接注冊接口本身而是注冊了一個工廠bean每次獲取的時候工廠bean會調(diào)用SqlSession.getMapper(Class)來創(chuàng)建接口的動態(tài)代理。所以你在業(yè)務代碼里能直接Autowired注入Mapper接口注入的實際對象就是代理對象。還有一點整合后的事務。Mybatis本身只提供對數(shù)據(jù)庫的操作能力但它沒有事務管理器。Spring通過DataSourceTransactionManager管理事務整合的時候SqlSessionFactoryBean用的是Spring事務管理下的數(shù)據(jù)源這樣Transactional才能生效。當方法調(diào)用MybatisTemplate執(zhí)行SQL時Spring的事務管理器會保證同一個方法里的SQL都在同一個事務里。這里有個常見問題如果你在Spring配置里自己new了一個DataSource沒有交給Spring管理那事務注解就會失效操作一條數(shù)據(jù)提交一條根本不走事務。排查的時候先看DataSource是不是容器里的單例bean。3. 手把手搭建一個注解開發(fā)Spring與Mybatis整合的項目3.1 基礎依賴和項目結(jié)構(gòu)理解原理之外還得能跑起來。這里我給一個完整的精簡版項目示例不依賴Spring Boot用傳統(tǒng)的Spring Mybatis整合方式把底層鏈路看得明明白白。項目用Maven管理先看pom.xml里最核心的依賴dependency groupIdorg.springframework/groupId artifactIdspring-context/artifactId version5.3.23/version /dependency dependency groupIdorg.springframework/groupId artifactIdspring-jdbc/artifactId version5.3.23/version /dependency dependency groupIdorg.mybatis/groupId artifactIdmybatis/artifactId version3.5.13/version /dependency dependency groupIdorg.mybatis/groupId artifactIdmybatis-spring/artifactId version3.0.3/version /dependency dependency groupIdmysql/groupId artifactIdmysql-connector-java/artifactId version8.0.33/version /dependency這里一定要加上spring-jdbc因為事務管理器要用它。mybatis-spring是兩者的橋接包專門負責把Mybatis的對象接入Spring容器。項目結(jié)構(gòu)就按標準的Java工程來src/main/java ├── com/demo/config │ └── SpringConfig.java ├── com/demo/entity │ └── User.java ├── com/demo/mapper │ └── UserMapper.java ├── com/demo/service │ ├── UserService.java │ └── UserServiceImpl.java ├── com/demo/App.java src/main/resources └── mapper └── UserMapper.xml3.2 核心配置類和數(shù)據(jù)源既然用的是注解開發(fā)整個Spring配置就交給Java配置類。先看數(shù)據(jù)源這塊我們這里手動配置一個簡單的HikariCP或者直接用DriverManagerDataSource都行生產(chǎn)環(huán)境建議用HikariCP測試就怎么簡單怎么來Configuration ComponentScan(com.demo) EnableTransactionManagement MapperScan(com.demo.mapper) PropertySource(classpath:db.properties) public class SpringConfig { Value(${jdbc.driver}) private String driver; Value(${jdbc.url}) private String url; Value(${jdbc.username}) private String username; Value(${jdbc.password}) private String password; Bean public DataSource dataSource() { HikariConfig config new HikariConfig(); config.setDriverClassName(driver); config.setJdbcUrl(url); config.setUsername(username); config.setPassword(password); config.setMaximumPoolSize(10); return new HikariDataSource(config); } Bean public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception { SqlSessionFactoryBean factoryBean new SqlSessionFactoryBean(); factoryBean.setDataSource(dataSource); org.apache.ibatis.session.Configuration configuration new org.apache.ibatis.session.Configuration(); configuration.setMapUnderscoreToCamelCase(true); configuration.setLogImpl(org.apache.ibatis.logging.stdout.StdOutImpl.class); factoryBean.setConfiguration(configuration); factoryBean.setMapperLocations(new PathMatchingResourcePatternResolver() .getResources(classpath:mapper/*.xml)); return factoryBean.getObject(); } Bean public DataSourceTransactionManager transactionManager(DataSource dataSource) { return new DataSourceTransactionManager(dataSource); } }幾個細節(jié)說一下。setMapUnderscoreToCamelCase(true)這個非常關(guān)鍵數(shù)據(jù)庫字段是create_timeJava屬性是createTime不開啟駝峰映射的話這個字段就注入不進去查出來全是null。setMapperLocations是告訴Spring去哪里加載Mapper的XML文件如果你用的是純注解SQL也就是Select、Insert這些那這行可以不寫但XML和注解混合的項目必須配置。EnableTransactionManagement開啟注解事務沒有這行Transactional不生效。3.3 Mapper接口與XML映射的寫法Mapper接口本身很簡單public interface UserMapper { User selectById(Param(id) Long id); ListUser selectList(); int insert(User user); int update(User user); int deleteById(Param(id) Long id); }對應的XML文件放在src/main/resources/mapper/UserMapper.xml里?xml version1.0 encodingUTF-8 ? !DOCTYPE mapper PUBLIC -//mybatis.org//DTD Mapper 3.0//EN http://mybatis.org/dtd/mybatis-3-mapper.dtd mapper namespacecom.demo.mapper.UserMapper select idselectById resultTypecom.demo.entity.User SELECT id, name, age, create_time FROM t_user WHERE id #{id} /select select idselectList resultTypecom.demo.entity.User SELECT id, name, age, create_time FROM t_user /select insert idinsert parameterTypecom.demo.entity.User useGeneratedKeystrue keyPropertyid INSERT INTO t_user(name, age) VALUES (#{name}, #{age}) /insert update idupdate parameterTypecom.demo.entity.User UPDATE t_user SET name #{name}, age #{age} WHERE id #{id} /update delete iddeleteById DELETE FROM t_user WHERE id #{id} /delete /mapper有兩點值得注意。namespace必須寫接口的全限定名不能寫錯寫錯的話運行時報錯還不好查。resultType如果你開了typeAliases可以寫別名但我建議起手階段就寫全限定名清晰不背鍋。useGeneratedKeystrue keyPropertyid是插入后回填自增主鍵到實體對象這個在新增后馬上要用到主鍵的場景比如插入訂單后要關(guān)聯(lián)訂單明細特別方便省得再查一次數(shù)據(jù)庫。3.4 Service層的使用和事務Service層直接注入Mapper接口加Transactional來控制事務Service public class UserServiceImpl implements UserService { Resource private UserMapper userMapper; Override Transactional(rollbackFor Exception.class) public int createUser(User user) { userMapper.insert(user); if (user.getAge() ! null user.getAge() 0) { throw new RuntimeException(年齡不能為負數(shù)); } return user.getId(); } }Transactional的rollbackFor Exception.class這個一定要寫因為Spring默認只在遇到RuntimeException時才回滾如果你代碼里拋的是一個自定義CheckedException不加這個屬性的話事務照樣提交數(shù)據(jù)就臟了。這個坑我印象很深有一次導入接口處理Excel解析里面拋了業(yè)務異常但事務沒回滾排查了半天發(fā)現(xiàn)就是沒加rollbackFor。啟動類就一行public class App { public static void main(String[] args) { AnnotationConfigApplicationContext context new AnnotationConfigApplicationContext(SpringConfig.class); UserService userService context.getBean(UserService.class); // 業(yè)務調(diào)用... context.close(); } }用AnnotationConfigApplicationContext加載配置類容器啟動時會自動掃描com.demo包創(chuàng)建所有bean生成Mapper代理注冊事務管理器。跑起來你會在控制臺看到Mybatis打印的SQL日志 Preparing: ...就是真正執(zhí)行的語句排查SQL問題全靠它。4. 整合過程中的常見問題與排查技巧4.1 啟動報錯NoSuchBeanDefinitionException、Invalid bound statement這是兩個出現(xiàn)頻率最高的錯誤。NoSuchBeanDefinitionException一般是掃描路徑?jīng)]覆蓋到接口或者MapperScan沒生效檢查啟動類和配置類上的ComponentScan路徑。Invalid bound statement (not found)說明Mapper接口找到了但接口方法和XML里的id對不上要么XML文件沒被加載要么namespace寫錯要么方法名和XML id不一致。排查這兩類問題我建議先看啟動日志。Spring啟動時會打印bean初始化情況你看有沒有類似userMapper這樣的bean名稱如果沒有說明根本沒掃描到。有的話再看Mybatis加載了多少個Mapper XML這些日志都會明確打印。把問題定位到具體層級比瞎猜強太多。4.2 事務不生效的排查思路事務不生效的常見原因除了前面說的DataSource不是同一個、沒寫rollbackFor還有一個容易被忽略的點同一個類的內(nèi)部調(diào)用。Transactional是基于Spring AOP動態(tài)代理實現(xiàn)的如果你在UserServiceImpl里直接寫一個方法內(nèi)部調(diào)用另一個帶有Transactional的方法事務是不生效的因為內(nèi)部調(diào)用沒有走代理對象。這個冷知識導致的現(xiàn)象就是外部調(diào)用方法AA內(nèi)部調(diào)用BB有事務B拋異常了但A的事務沒回滾。解決辦法一是把B挪到另一個Service里二是自己注入自身代理三是用AopContext.currentProxy()獲取當前代理再調(diào)用。我遇到過一個奇葩case一開始以為是事務沒生效后來發(fā)現(xiàn)是DataSource被C3P0和Druid兩個連接池配置了雙份Spring容器里有兩個DataSource事務管理器管的那個和Mybatis用的那個根本不是同一個。你說這種問題怎么排查看日志基本沒用得把所有關(guān)于數(shù)據(jù)源的配置全部搜一遍把多余的那份注釋掉世界就清凈了。4.3 Mybatis屬性映射和SQL日志打印的實用技巧數(shù)據(jù)庫字段是下劃線風格、Java屬性是駝峰風格這個前面說了開啟mapUnderscoreToCamelCase就行。但如果你用的是Select注解直接在接口里寫SQL不想建XML文件那么SQL可以這樣寫Select(SELECT * FROM t_user WHERE id #{id}) Results(id userMap, value { Result(column create_time, property createTime) }) User selectById(Long id);SQL日志這塊開發(fā)階段我喜歡在Mybatis配置里加上StdOutImpl就是上面配置類里那行configuration.setLogImpl(...)SQL會自動打印到控制臺。但生產(chǎn)環(huán)境別這么干日志量太大而且會打印完整參數(shù)有數(shù)據(jù)泄露風險。線上的做法是用p6spy這類監(jiān)控組件或者把Mybatis日志級別調(diào)到DEBUG交給日志框架統(tǒng)一管理。用idea mybatis log free插件也可以把參數(shù)替換進SQL里直接顯示可執(zhí)行的完整語句排錯更快。4.4 關(guān)于邏輯刪除和Mybatis Plus的一些補充提到Mybatis繞不開Mybatis Plus現(xiàn)在新項目用Mybatis Plus的很多。它有一個內(nèi)置的邏輯刪除功能用起來很爽但有個坑你寫了自定義SQL時如果沒注意它自動拼接的deleted0條件查出來的數(shù)據(jù)可能不符合預期。比如你寫一個自定義JOIN查詢沒有顯式加邏輯刪除過濾條件Mybatis Plus的插件可能在某些場景下不生效。我的經(jīng)驗是不管是Mybatis還是Mybatis Plus自定義SQL務必自己把控過濾條件別把邏輯依賴在框架的自動行為上。另外Mybatis Plus的saveOrUpdateBatch在多數(shù)據(jù)源環(huán)境下有兼容問題如果項目里配了多數(shù)據(jù)源、分庫分表組件使用這類批量方法之前一定提前測試特別是主鍵策略和分布式ID生成器沖突的場景。5. 從學習角度給讀者的進階建議5.1 面試?？嫉狞c要連成知識網(wǎng)結(jié)合這份PPT的主題Spring注解開發(fā)和Spring與Mybatis整合面試官大概率會這么問Autowired和Resource的區(qū)別是什么Component和Bean有什么區(qū)別Spring容器啟動流程是怎樣的Mybatis的#{}和${}有什么區(qū)別Mapper接口沒有實現(xiàn)類Spring怎么代理的這些問題看似零散但核心都指向一個東西你有沒有真正理解IoC和DI。我建議學習的時候把知識串起來先理解容器做了什么再理解注解如何驅(qū)動容器干活最后理解Mybatis如何把自己扮演的角色塞進容器里。這樣面試答起來才不是背答案而是層層遞進地講設計思路。5.2 讀一點點源碼勝過看十篇博客說真的做Java開發(fā)繞不開Spring系源碼。你不用全讀抓住一條主線就行Spring容器的刷新過程refresh方法、Bean的實例化和初始化流程、BeanPostProcessor的擴展點、Mybatis的MapperScan如何通過ImportBeanDefinitionRegistrar把Mapper注入容器的。這幾個點走一遍你立刻能解釋很多實際開發(fā)中的靈異現(xiàn)象。我當年就是被一次Invalid bound statement折磨了兩天才開始硬著頭皮去看MapperRegistry和MapperAnnotationBuilder的源碼看完才發(fā)現(xiàn)Mybatis的XML和注解最終都會被解析成MapperAnnotationBuilder里的方法定義怪不得id對不上就找不到。從那以后遇到問題我第一反應不是搜報錯信息而是想這個報錯是在哪個環(huán)節(jié)拋出來的鏈路走一遍基本能定位個八九不離十。5.3 建議動手把項目從零寫一遍看再多文檔不如自己敲一遍。建議你用Maven從零搭一個這種傳統(tǒng)Spring Mybatis的項目把下面這些事一樣一樣做完做完基本就通透了用Configuration定義配置類替代原來的XML。手動配DataSource和SqlSessionFactoryBean不依賴Spring Boot自動配置。寫一個帶Transactional的Service驗證事務是否真的回滾。分別用XML和注解兩種方式寫Mapper查詢體會兩者的風格差異。故意把XML里的id寫錯觀察報錯信息提高定位問題的速度。嘗試開啟駝峰映射和不開啟對比實體類字段為null的原因。尤其是第一項很多人在Spring Boot里用得順手但根本不知道Spring容器是怎么初始化Bean的?；氐皆h(huán)境寫一遍boot里那層自動配置的神秘面紗就徹底沒了。這一步走了你對Spring的理解會比絕大部分同齡人深一個檔次。最后說個自己的體會吧。從最開始照著文檔抄XML配置到后來能用注解一行搞定再到后面讀懂容器源碼這個過程中最爽的不是學會某個API而是踩坑后明白每個設計背后的約束條件。Spring和Mybatis能統(tǒng)治Java后端這么多年靠的就是它們把復雜留給自己把簡單留給開發(fā)者的妥帖設計。希望這篇整理能幫你少走點彎路以后寫代碼時遇到奇怪問題能想起鏈路背后的那一步。本文還有配套的精品資源點擊獲取 Spring注解開發(fā)與Mybatis整合：從原理到實踐，徹底搞懂IoC與事務管理
簡介這是一份面向Java開發(fā)學習者的SSM框架入門課件聚焦Spring注解開發(fā)與Spring整合MyBatis兩大主題適合正在學習Spring核心容器、依賴注入及持久層框架整合的讀者。講解脈絡清晰從IoC/DI基本思想、BeanFactory與ApplicationContext容器層次到注解定義bean、純注解開發(fā)、第三方bean管理和依賴注入再延伸到Spring整合MyBatis與JUnit層層遞進便于系統(tǒng)建立SSM整合知識框架。壓縮包內(nèi)共1個pptx文件約2.99MB彩色排版通過結(jié)構(gòu)圖、示例代碼和XML配置對照展示知識點既可用作課堂同步講義也可作為考前復習提綱。目前已有181人學習使用內(nèi)容覆蓋Spring概述、核心容器總結(jié)、注解開發(fā)、整合MyBatis與JUnit等章節(jié)適合希望快速掌握Spring注解風格開發(fā)和SSM整合配置的初學者進階參考。 看到這個標題我就知道這應該是不少Java開發(fā)入行時都會遇到的一份PPT——講注解開發(fā)也講SSM里最核心的Spring和Mybatis整合。老實說這類材料網(wǎng)上多得是但絕大多數(shù)要么只貼代碼不講為什么要么上來就甩配置把人看懵。這篇我就以做過的項目經(jīng)驗為底把注解開發(fā)和兩者整合這條線從頭捋一遍不光是能用還得讓你知道它是怎么跑起來的。1. Spring注解開發(fā)的核心思路從XML到注解到底省了什么1.1 為什么注解能取代一堆XML配置早些年做Spring項目光一個applicationContext.xml就能寫上好幾百行里面全是bean標簽定義一個對象就得寫一段對象多了以后維護成本直接爆炸。后來Spring從2.5開始引入注解到了Spring Boot時代基本全面轉(zhuǎn)向注解和自動配置這背后其實是三層邏輯。第一注解把“定義”和“使用”放在了一起。你在類上寫一個Service這個類就是業(yè)務層組件不用再跑到配置文件里找對應的bean定義。類本身即文檔別人看代碼就知道這個類在容器里扮演什么角色而不是把代碼和配置來回切換。第二注解開發(fā)能大幅減少樣板代碼。比如依賴注入你只要用Autowired聲明一下Spring容器啟動時就會把對應的bean塞進來不需要寫setter注入或構(gòu)造器注入的XML。第三注解讓項目的啟動和構(gòu)建流程更輕尤其在微服務拆分的場景下一個服務一個模塊各自用注解完成裝配互不干擾。但有一點我得提醒你注解不是銀彈。它把配置從XML搬到了代碼里雖然直觀但如果你想全局查一下某個bean被哪些地方引用還是會比搜XML麻煩一點。這也是為什么Spring Boot后來引入了ConfigurationProperties這類配置綁定方式把外部配置和Java對象做映射盡量把容易變的東西留在配置文件里把穩(wěn)定的裝配邏輯留在代碼里。我的理解是注解解決的是“怎么裝配的問題”配置文件解決的是“參數(shù)是什么的問題”兩者要搭配用別走極端。1.2 實操里最高頻的注解組合逐個說透Component系列最基礎Service、Repository、Controller其實都是它的衍生本質(zhì)都是把類注冊成Spring容器中的bean只是語義層面區(qū)分了層次。Autowired是按類型注入Resource是按名稱注入這倆面試經(jīng)常會問實際開發(fā)里如果你的容器里只有一個實現(xiàn)類兩者用起來沒區(qū)別一旦有多個實現(xiàn)Autowired需要配合Qualifier指定名字Resource自己就能指定name屬性。我個人的習慣是能用一個實現(xiàn)類就直接Autowired有多實現(xiàn)時優(yōu)先Resource(name xxx)寫起來短也不容易出錯。Configuration和Bean是用來定義配置類的簡單說就是讓你用Java代碼代替XML里的bean定義。比如你要注入一個第三方庫的對象沒法在類上直接加Component那就在配置類里寫一個方法方法上標注Bean方法的返回值就是容器里注冊的對象。這個方法名字默認就是bean名稱也可以顯式指定Bean(name)。ComponentScan負責掃描包路徑Spring Boot里默認掃描啟動類所在包及其子包。這里有個坑有時候你把新寫的Service放在啟動類包外面的目錄里結(jié)果啟動報了NoSuchBeanDefinitionException多半就是掃描路徑?jīng)]覆蓋到。處理方式要么調(diào)整包結(jié)構(gòu)要么在啟動類上顯式加上ComponentScan(basePackages com.xxx)。還有一個容易被忽略的是Scope默認單例這個對于絕大多數(shù)場景沒問題但你在多線程環(huán)境下往類成員變量里塞狀態(tài)就要小心了。單例bean在多線程下是共享的成員變量容易出并發(fā)問題。需要原型作用域時在Bean或Component上標注Scope(prototype)即可。說實話我工作這些年用到prototype的次數(shù)很少大多數(shù)情況都是把無狀態(tài)的服務類設計成單例有狀態(tài)的數(shù)據(jù)往方法參數(shù)和數(shù)據(jù)庫里放。Value用來注入配置文件里的值PropertySource指定外部配置文件位置比如PropertySource(classpath:jdbc.properties)。Value(${jdbc.url})這樣就能讀出來但這個方案在字段多的時候很啰嗦Spring Boot時代基本被ConfigurationProperties取代了。1.3 注解開發(fā)的底層邏輯Bean生命周期是怎么回事很多人面試被問到Spring三級緩存其實這玩意兒跟注解開發(fā)也有關(guān)系。Spring IoC容器啟動的時候會先掃描所有加了注解的類生成BeanDefinition然后按照依賴關(guān)系實例化bean。實例化并不等于初始化完成Spring把對象創(chuàng)建分成了好幾步。三級緩存解決的是循環(huán)依賴問題比如A依賴B、B依賴A沒有三級緩存的話兩個對象互相引用就會死鎖。一級緩存是成品對象二級緩存是早期暴露的半成品三級緩存放的是對象工廠。注解注入基本都是在對象創(chuàng)建完成后通過后置處理器來完成的。我在實際工作中直接遇到循環(huán)依賴的次數(shù)不多但確實有一次加了Transactional后發(fā)現(xiàn)啟動報錯定位下來是A依賴B、B又依賴A當時就把其中一個依賴改成Lazy延遲加載解決了。后來我換了個思路直接從設計上把循環(huán)依賴干掉該拆的方法拆出去該抽的類抽出來反而代碼結(jié)構(gòu)更清爽。所以我的建議是三級緩存這東西面試要知道但工程項目里碰到循環(huán)依賴優(yōu)先想怎么重構(gòu)而不是依賴緩存機制硬扛。2. Spring與Mybatis整合為什么要整合以及整合時發(fā)生了什么2.1 原生Mybatis的痛點與整合思路Mybatis本身是個半自動ORM框架SQL由你控制執(zhí)行結(jié)果自動映射成Java對象靈活性很高。但如果你不用Spring就得自己手動創(chuàng)建SqlSessionFactory自己管理SqlSession每個Mapper接口還得手動寫實現(xiàn)類去調(diào)用SqlSession的方法或者用Mybatis官方提供的Mapper動態(tài)代理。這在簡單項目里還能接受項目一復雜就是災難。真正接手一個項目后你會發(fā)現(xiàn)純Mybatis的使用方式有四個致命傷第一SqlSession線程不安全你不能把它定義為單例每個線程都要獨立的SqlSession第二事務控制全靠自己寫commit/rollback稍不留神就出現(xiàn)數(shù)據(jù)不一致第三Mapper的獲取和生命周期管理非常繁瑣每個業(yè)務代碼里都得寫“獲取session、調(diào)用mapper、關(guān)閉session”的樣板代碼第四跟Spring的聲明式事務Transactional沒法直接集成事務邊界只能靠人肉維護。所以Spring與Mybatis整合本質(zhì)就是讓Spring容器接管Mybatis的核心對象。SqlSessionFactory被定義成單例SqlSession的生命周期交給Spring的SqlSessionTemplate統(tǒng)一管理事務交給Spring的TransactionManager統(tǒng)一處理Mapper接口的代理生成也交給Spring掃描注冊。你這邊的開發(fā)就只需要定義一個接口加幾個注解或者寫個XML映射文件方法調(diào)用時自動拿到代理對象去執(zhí)行SQL。2.2 SqlSessionFactoryBean和MapperScan是怎么回事你用Spring Boot的時候一般只需要在啟動類上加MapperScan(com.xxx.mapper)然后Mybatis的配置類就自動干了一堆活。但如果你理解了底層無非就是幾件事。首先SqlSessionFactoryBean實現(xiàn)了Spring的FactoryBean接口它的作用是把Mybatis的SqlSessionFactory創(chuàng)建過程封裝起來交給Spring容器管理。這里面會讀取Mybatis全局配置注冊typeAliases、typeHandlers、Mapper XML映射文件的位置等。只有這個factory創(chuàng)建好了后續(xù)的Mapper代理才有基礎。其次MapperScan這個注解的作用是掃描指定包下的所有接口把它們注冊成MapperFactoryBean。注意這里不是直接注冊接口本身而是注冊了一個工廠bean每次獲取的時候工廠bean會調(diào)用SqlSession.getMapper(Class)來創(chuàng)建接口的動態(tài)代理。所以你在業(yè)務代碼里能直接Autowired注入Mapper接口注入的實際對象就是代理對象。還有一點整合后的事務。Mybatis本身只提供對數(shù)據(jù)庫的操作能力但它沒有事務管理器。Spring通過DataSourceTransactionManager管理事務整合的時候SqlSessionFactoryBean用的是Spring事務管理下的數(shù)據(jù)源這樣Transactional才能生效。當方法調(diào)用MybatisTemplate執(zhí)行SQL時Spring的事務管理器會保證同一個方法里的SQL都在同一個事務里。這里有個常見問題如果你在Spring配置里自己new了一個DataSource沒有交給Spring管理那事務注解就會失效操作一條數(shù)據(jù)提交一條根本不走事務。排查的時候先看DataSource是不是容器里的單例bean。3. 手把手搭建一個注解開發(fā)Spring與Mybatis整合的項目3.1 基礎依賴和項目結(jié)構(gòu)理解原理之外還得能跑起來。這里我給一個完整的精簡版項目示例不依賴Spring Boot用傳統(tǒng)的Spring Mybatis整合方式把底層鏈路看得明明白白。項目用Maven管理先看pom.xml里最核心的依賴dependency groupIdorg.springframework/groupId artifactIdspring-context/artifactId version5.3.23/version /dependency dependency groupIdorg.springframework/groupId artifactIdspring-jdbc/artifactId version5.3.23/version /dependency dependency groupIdorg.mybatis/groupId artifactIdmybatis/artifactId version3.5.13/version /dependency dependency groupIdorg.mybatis/groupId artifactIdmybatis-spring/artifactId version3.0.3/version /dependency dependency groupIdmysql/groupId artifactIdmysql-connector-java/artifactId version8.0.33/version /dependency這里一定要加上spring-jdbc因為事務管理器要用它。mybatis-spring是兩者的橋接包專門負責把Mybatis的對象接入Spring容器。項目結(jié)構(gòu)就按標準的Java工程來src/main/java ├── com/demo/config │ └── SpringConfig.java ├── com/demo/entity │ └── User.java ├── com/demo/mapper │ └── UserMapper.java ├── com/demo/service │ ├── UserService.java │ └── UserServiceImpl.java ├── com/demo/App.java src/main/resources └── mapper └── UserMapper.xml3.2 核心配置類和數(shù)據(jù)源既然用的是注解開發(fā)整個Spring配置就交給Java配置類。先看數(shù)據(jù)源這塊我們這里手動配置一個簡單的HikariCP或者直接用DriverManagerDataSource都行生產(chǎn)環(huán)境建議用HikariCP測試就怎么簡單怎么來Configuration ComponentScan(com.demo) EnableTransactionManagement MapperScan(com.demo.mapper) PropertySource(classpath:db.properties) public class SpringConfig { Value(${jdbc.driver}) private String driver; Value(${jdbc.url}) private String url; Value(${jdbc.username}) private String username; Value(${jdbc.password}) private String password; Bean public DataSource dataSource() { HikariConfig config new HikariConfig(); config.setDriverClassName(driver); config.setJdbcUrl(url); config.setUsername(username); config.setPassword(password); config.setMaximumPoolSize(10); return new HikariDataSource(config); } Bean public SqlSessionFactory sqlSessionFactory(DataSource dataSource) throws Exception { SqlSessionFactoryBean factoryBean new SqlSessionFactoryBean(); factoryBean.setDataSource(dataSource); org.apache.ibatis.session.Configuration configuration new org.apache.ibatis.session.Configuration(); configuration.setMapUnderscoreToCamelCase(true); configuration.setLogImpl(org.apache.ibatis.logging.stdout.StdOutImpl.class); factoryBean.setConfiguration(configuration); factoryBean.setMapperLocations(new PathMatchingResourcePatternResolver() .getResources(classpath:mapper/*.xml)); return factoryBean.getObject(); } Bean public DataSourceTransactionManager transactionManager(DataSource dataSource) { return new DataSourceTransactionManager(dataSource); } }幾個細節(jié)說一下。setMapUnderscoreToCamelCase(true)這個非常關(guān)鍵數(shù)據(jù)庫字段是create_timeJava屬性是createTime不開啟駝峰映射的話這個字段就注入不進去查出來全是null。setMapperLocations是告訴Spring去哪里加載Mapper的XML文件如果你用的是純注解SQL也就是Select、Insert這些那這行可以不寫但XML和注解混合的項目必須配置。EnableTransactionManagement開啟注解事務沒有這行Transactional不生效。3.3 Mapper接口與XML映射的寫法Mapper接口本身很簡單public interface UserMapper { User selectById(Param(id) Long id); ListUser selectList(); int insert(User user); int update(User user); int deleteById(Param(id) Long id); }對應的XML文件放在src/main/resources/mapper/UserMapper.xml里?xml version1.0 encodingUTF-8 ? !DOCTYPE mapper PUBLIC -//mybatis.org//DTD Mapper 3.0//EN http://mybatis.org/dtd/mybatis-3-mapper.dtd mapper namespacecom.demo.mapper.UserMapper select idselectById resultTypecom.demo.entity.User SELECT id, name, age, create_time FROM t_user WHERE id #{id} /select select idselectList resultTypecom.demo.entity.User SELECT id, name, age, create_time FROM t_user /select insert idinsert parameterTypecom.demo.entity.User useGeneratedKeystrue keyPropertyid INSERT INTO t_user(name, age) VALUES (#{name}, #{age}) /insert update idupdate parameterTypecom.demo.entity.User UPDATE t_user SET name #{name}, age #{age} WHERE id #{id} /update delete iddeleteById DELETE FROM t_user WHERE id #{id} /delete /mapper有兩點值得注意。namespace必須寫接口的全限定名不能寫錯寫錯的話運行時報錯還不好查。resultType如果你開了typeAliases可以寫別名但我建議起手階段就寫全限定名清晰不背鍋。useGeneratedKeystrue keyPropertyid是插入后回填自增主鍵到實體對象這個在新增后馬上要用到主鍵的場景比如插入訂單后要關(guān)聯(lián)訂單明細特別方便省得再查一次數(shù)據(jù)庫。3.4 Service層的使用和事務Service層直接注入Mapper接口加Transactional來控制事務Service public class UserServiceImpl implements UserService { Resource private UserMapper userMapper; Override Transactional(rollbackFor Exception.class) public int createUser(User user) { userMapper.insert(user); if (user.getAge() ! null user.getAge() 0) { throw new RuntimeException(年齡不能為負數(shù)); } return user.getId(); } }Transactional的rollbackFor Exception.class這個一定要寫因為Spring默認只在遇到RuntimeException時才回滾如果你代碼里拋的是一個自定義CheckedException不加這個屬性的話事務照樣提交數(shù)據(jù)就臟了。這個坑我印象很深有一次導入接口處理Excel解析里面拋了業(yè)務異常但事務沒回滾排查了半天發(fā)現(xiàn)就是沒加rollbackFor。啟動類就一行public class App { public static void main(String[] args) { AnnotationConfigApplicationContext context new AnnotationConfigApplicationContext(SpringConfig.class); UserService userService context.getBean(UserService.class); // 業(yè)務調(diào)用... context.close(); } }用AnnotationConfigApplicationContext加載配置類容器啟動時會自動掃描com.demo包創(chuàng)建所有bean生成Mapper代理注冊事務管理器。跑起來你會在控制臺看到Mybatis打印的SQL日志 Preparing: ...就是真正執(zhí)行的語句排查SQL問題全靠它。4. 整合過程中的常見問題與排查技巧4.1 啟動報錯NoSuchBeanDefinitionException、Invalid bound statement這是兩個出現(xiàn)頻率最高的錯誤。NoSuchBeanDefinitionException一般是掃描路徑?jīng)]覆蓋到接口或者MapperScan沒生效檢查啟動類和配置類上的ComponentScan路徑。Invalid bound statement (not found)說明Mapper接口找到了但接口方法和XML里的id對不上要么XML文件沒被加載要么namespace寫錯要么方法名和XML id不一致。排查這兩類問題我建議先看啟動日志。Spring啟動時會打印bean初始化情況你看有沒有類似userMapper這樣的bean名稱如果沒有說明根本沒掃描到。有的話再看Mybatis加載了多少個Mapper XML這些日志都會明確打印。把問題定位到具體層級比瞎猜強太多。4.2 事務不生效的排查思路事務不生效的常見原因除了前面說的DataSource不是同一個、沒寫rollbackFor還有一個容易被忽略的點同一個類的內(nèi)部調(diào)用。Transactional是基于Spring AOP動態(tài)代理實現(xiàn)的如果你在UserServiceImpl里直接寫一個方法內(nèi)部調(diào)用另一個帶有Transactional的方法事務是不生效的因為內(nèi)部調(diào)用沒有走代理對象。這個冷知識導致的現(xiàn)象就是外部調(diào)用方法AA內(nèi)部調(diào)用BB有事務B拋異常了但A的事務沒回滾。解決辦法一是把B挪到另一個Service里二是自己注入自身代理三是用AopContext.currentProxy()獲取當前代理再調(diào)用。我遇到過一個奇葩case一開始以為是事務沒生效后來發(fā)現(xiàn)是DataSource被C3P0和Druid兩個連接池配置了雙份Spring容器里有兩個DataSource事務管理器管的那個和Mybatis用的那個根本不是同一個。你說這種問題怎么排查看日志基本沒用得把所有關(guān)于數(shù)據(jù)源的配置全部搜一遍把多余的那份注釋掉世界就清凈了。4.3 Mybatis屬性映射和SQL日志打印的實用技巧數(shù)據(jù)庫字段是下劃線風格、Java屬性是駝峰風格這個前面說了開啟mapUnderscoreToCamelCase就行。但如果你用的是Select注解直接在接口里寫SQL不想建XML文件那么SQL可以這樣寫Select(SELECT * FROM t_user WHERE id #{id}) Results(id userMap, value { Result(column create_time, property createTime) }) User selectById(Long id);SQL日志這塊開發(fā)階段我喜歡在Mybatis配置里加上StdOutImpl就是上面配置類里那行configuration.setLogImpl(...)SQL會自動打印到控制臺。但生產(chǎn)環(huán)境別這么干日志量太大而且會打印完整參數(shù)有數(shù)據(jù)泄露風險。線上的做法是用p6spy這類監(jiān)控組件或者把Mybatis日志級別調(diào)到DEBUG交給日志框架統(tǒng)一管理。用idea mybatis log free插件也可以把參數(shù)替換進SQL里直接顯示可執(zhí)行的完整語句排錯更快。4.4 關(guān)于邏輯刪除和Mybatis Plus的一些補充提到Mybatis繞不開Mybatis Plus現(xiàn)在新項目用Mybatis Plus的很多。它有一個內(nèi)置的邏輯刪除功能用起來很爽但有個坑你寫了自定義SQL時如果沒注意它自動拼接的deleted0條件查出來的數(shù)據(jù)可能不符合預期。比如你寫一個自定義JOIN查詢沒有顯式加邏輯刪除過濾條件Mybatis Plus的插件可能在某些場景下不生效。我的經(jīng)驗是不管是Mybatis還是Mybatis Plus自定義SQL務必自己把控過濾條件別把邏輯依賴在框架的自動行為上。另外Mybatis Plus的saveOrUpdateBatch在多數(shù)據(jù)源環(huán)境下有兼容問題如果項目里配了多數(shù)據(jù)源、分庫分表組件使用這類批量方法之前一定提前測試特別是主鍵策略和分布式ID生成器沖突的場景。5. 從學習角度給讀者的進階建議5.1 面試?？嫉狞c要連成知識網(wǎng)結(jié)合這份PPT的主題Spring注解開發(fā)和Spring與Mybatis整合面試官大概率會這么問Autowired和Resource的區(qū)別是什么Component和Bean有什么區(qū)別Spring容器啟動流程是怎樣的Mybatis的#{}和${}有什么區(qū)別Mapper接口沒有實現(xiàn)類Spring怎么代理的這些問題看似零散但核心都指向一個東西你有沒有真正理解IoC和DI。我建議學習的時候把知識串起來先理解容器做了什么再理解注解如何驅(qū)動容器干活最后理解Mybatis如何把自己扮演的角色塞進容器里。這樣面試答起來才不是背答案而是層層遞進地講設計思路。5.2 讀一點點源碼勝過看十篇博客說真的做Java開發(fā)繞不開Spring系源碼。你不用全讀抓住一條主線就行Spring容器的刷新過程refresh方法、Bean的實例化和初始化流程、BeanPostProcessor的擴展點、Mybatis的MapperScan如何通過ImportBeanDefinitionRegistrar把Mapper注入容器的。這幾個點走一遍你立刻能解釋很多實際開發(fā)中的靈異現(xiàn)象。我當年就是被一次Invalid bound statement折磨了兩天才開始硬著頭皮去看MapperRegistry和MapperAnnotationBuilder的源碼看完才發(fā)現(xiàn)Mybatis的XML和注解最終都會被解析成MapperAnnotationBuilder里的方法定義怪不得id對不上就找不到。從那以后遇到問題我第一反應不是搜報錯信息而是想這個報錯是在哪個環(huán)節(jié)拋出來的鏈路走一遍基本能定位個八九不離十。5.3 建議動手把項目從零寫一遍看再多文檔不如自己敲一遍。建議你用Maven從零搭一個這種傳統(tǒng)Spring Mybatis的項目把下面這些事一樣一樣做完做完基本就通透了用Configuration定義配置類替代原來的XML。手動配DataSource和SqlSessionFactoryBean不依賴Spring Boot自動配置。寫一個帶Transactional的Service驗證事務是否真的回滾。分別用XML和注解兩種方式寫Mapper查詢體會兩者的風格差異。故意把XML里的id寫錯觀察報錯信息提高定位問題的速度。嘗試開啟駝峰映射和不開啟對比實體類字段為null的原因。尤其是第一項很多人在Spring Boot里用得順手但根本不知道Spring容器是怎么初始化Bean的?；氐皆h(huán)境寫一遍boot里那層自動配置的神秘面紗就徹底沒了。這一步走了你對Spring的理解會比絕大部分同齡人深一個檔次。最后說個自己的體會吧。從最開始照著文檔抄XML配置到后來能用注解一行搞定再到后面讀懂容器源碼這個過程中最爽的不是學會某個API而是踩坑后明白每個設計背后的約束條件。Spring和Mybatis能統(tǒng)治Java后端這么多年靠的就是它們把復雜留給自己把簡單留給開發(fā)者的妥帖設計。希望這篇整理能幫你少走點彎路以后寫代碼時遇到奇怪問題能想起鏈路背后的那一步。本文還有配套的精品資源點擊獲取