SpringBoot | 3.2 整合MyBatis

本文轉載自查看原文 2021-08-08 18:59 288 學習筆記/ SpringBoot學習筆記

前言
1. 導入MyBatis場景
- 1.1 初始化導向
- 1.2 手動導入
2. *MyBatis自動配置原理
3. 全局配置文件
- @Mapper
- @MapperScan
4 總結
最后

前言

通過前一篇的學習，我們知道可以使用JDBC操作數據庫，但在實際生產中，我們一般使用MyBatis。在本篇，可以學習到SpringBoot如何整合MyBatis框架，以及相關自動配置原理。

MyBatis是目前Java持久層最為主流的技術之一，它可以避免幾乎所有的JDBC代碼和手動設置參數以及獲取結果集。同時，MyBatis是基於一種SQL到POJO的模型，需要我們提供SQL、映射關系以及POJO。由於本筆記為SpringBoot系列筆記，故重點放在SpringBoot整合使用MyBatis。

注：在說明注解時，第一點加粗為注解中文含義，第二點為一般加在哪身上，縮進或代碼塊為示例，如：

@注解

中文含義
加在哪
其他……
- 語句示例
```
//代碼示例
```

1. 導入MyBatis場景

在SpringBoot中有兩種導入場景方式，一種是初始化導向，另一種是手動導入。

*這里需要與前文的兩種配置方式做區別：筆者的導入指往應用中添加相應場景，注重一個從0到1的過程；而前文Druid連接池的兩種配置方式雖然也有導入的意思，但更加注重導入后的配置過程，是一個從1到2的過程。

1.1 初始化導向

初始化導向指在新建SpringBoot項目工程時進行導入：
MyBatis的初始化導向

1.2 手動導入

手動導入只需要在SpringBoot的pom.xml文件里添加下面場景即可：

<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.1.4</version>
</dependency>

2. *MyBatis自動配置原理

MyBatis的自動配置原理跟Druid差不多，我們可以通過源碼分析得出可以自己配置哪些屬性，以及配置這些屬性時的前綴。

加入MyBatis場景后，我們可以發現該場景里有：

通過前面的文章，我們知道SpringBoot會先找到對應場景的自動配置類，在這里是MybatisAutoConfiguration

@Configuration
@ConditionalOnClass({ SqlSessionFactory.class, SqlSessionFactoryBean.class })
@ConditionalOnBean(DataSource.class)
@EnableConfigurationProperties(MybatisProperties.class) // MyBatis配置項綁定類
@AutoConfigureAfter({ DataSourceAutoConfiguration.class, MybatisLanguageDriverAutoConfiguration.class })
public class MybatisAutoConfiguration {
}

從源碼中，我們可以得到以下信息：

跟MybatisProperties配置類綁定，

配置屬性的前綴為 mybatis

@ConfigurationProperties(prefix = "mybatis")
public class MybatisProperties

全局配置文件：使用Mybatis需要進行全局配置；
SqlSessionFactory: 用來生成SqlSession；
- SqlSession是MyBatis操作的核心，是一個功能性代碼，通常使用單例模式（在MyBatis的生命周期中只存在一個SqlSessionFactory）；
SqlSession：自動配置了SqlSessionTemplate，可以生成SqlSession；
@Import(AutoConfiguredMapperScannerRegistrar.class）：導入的類里有定義如何操作@Mapper注解的接口；
- @Mapper：只要寫的操作MyBatis的接口標注了@Mapper就會被自動掃描進容器。

MyBatis配置內容結構

3. 全局配置文件

全局配置文件的書寫方式有三種，分別是配置模式、注解模式以及混合模式。在配置之前，我們需要做些准備工作，讓SpringBoot知道我們的配置文件寫在哪里。

准備工作：

配置全局配置文件位置（在application.yaml中指定Mapper配置文件的位置，以及指定全局配置文件的信息，建議配置在mybatis.configuration）；

mybatis:
  #全局配置文件位置
  config-location: classpath:mybatis/mybatis-config.xml  
  #sql映射文件位置
  mapper-locations: classpath:mybatis/mapper/*.xml 
  
  #定義別名掃描的包，需要與@Alias聯合使用
  type-aliases-package: ……
  #具體類需要與@MappedJdbcTypes聯合使用
  type-handlers-package: ……
  #執行器（Executor），可以配置STMPLE、REUSE、BATCH、默認為STMPLE
  executor-type: ……
  
  configuration:
    #配置MyBatis插件（攔截器等）
    interceptors: ……
    #級聯延遲加載配置屬性
    aggressive-lazy-loading: ……

注意config-location與mapper-locations不能同在，理由如下：
當需要使用mybatis-config.xml配置文件的時需要配置config-location，config-location的作用是確定mybatis-config.xml文件位置；而mapper-locations是用來注冊xxxmapper.xml文件。如果使用了mybatis-config.xml，並且里面配置了mapper，那就不需要mapper-locations。

編寫mapper接口，使用標准@Mapper注解（也可以在啟動類上加上@MapperScan替換@Mapper ）

@Mapper

映射配置；
用在接口類上
在接口類上添加了@Mapper，在編譯之后會生成相應的接口實現類；
如果有多組接口需要編譯成實現類，需要在每個接口上標注一個@Mapper；
```
@Mapper
public interface UserDAO {
   //代碼
}
```

@MapperScan

映射掃描配置；
用在主啟動類下；
指定要變成實現類的接口所在的包，然后包下面的所有接口在編譯之后都會生成相應的實現類；
將MyBatis所需的對應接口掃描到Spring IOC容器中；

可以解決@Mapper標注過多問題，直接在主啟動類上加上一個@MapperScan即可；

@SpringBootApplication
//@MapperScan("com.dlhjw.mapper")
@MapperScan(
    //指定掃描包
    basePackages = "com.dlhjw.mapper",
    //指定SqlSessionFactory，如果sqlSessionTemplate被指定，則作廢
    sqlSessionFactoryRef = "sqlSessionFactory",
    //指定sqlSessionTemplate，將忽略sqlSessionFactory的配置（優先級高）
    sqlSessionTemplateRef = “sqlSessionTemplate”,
    //限制掃描接口，不常用
    //markerInterface = class.class,
    annotationClass = Repository.class
)
public class SpringbootMybatisDemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringbootMybatisDemoApplication.class, args);
    }
}

【以下不常用、不推薦】 上述兩個接口都可以讓SpringBoot知道用戶配置的MyBatis映射關系在哪，除了用接口方式外，還可以：

通過MapperFactoryBean裝配MyBatis；
使用MapperScannerConfigurer；
使用MyBatis接口（因為SqlSessionFactory是SpringBoot自動生成好了，所以直接拿來使用）；

上面兩個接口可改成如下代碼：（不常用、不推薦）

1. 通過MapperFactoryBean裝配MyBatis：

@Autowired
SqlSessionFactory sqlSessionFactory = null;

//定義一個MyBatis的Mapper接口
@Bean
public MapperFactoryBean<MyBatisUserDao> initMyBatisUserDao(){
    MapperFactoryBean<MyBatisUserDao> bean = new MapperFactoryBean<>();
    bean.setMapperInterface(UserDAO.class);
    bean.setSessionFactory(sqlSessionFactory);
    return beam;
}

2. 使用MapperScannerConfigurer：

@Bean
public MapperScannerConfigurer mapperScannerConfig(){
    //定義掃描器實例
    MapperScannerConfigurer mapperScannerConfigurer = new MapperScannerConfigurer();
    //加載SqlSessionFactory，SpringBoot會自動生產，SqlSessionFactory實例
    mapperScannerConfigurer.setSqlSessionFactoryBeanName("sqlSessionFactory");
    //定義掃描的包
    mapperScannerConfigurer.setBeanPackage("com.dlhjw.mapper");
    //限定被標注@Repository的接口才被掃描
    mapperScannerConfigurer.setAnnotationClass(Repository.class);
    //通過繼承某個接口限制掃描，一般使用不多
    //mapperScannerConfigurer.setMarkerInterface(....);
    return mapperScannerConfigurer;
}

3. 使用MyBatis接口：

public interface MyBatisUserService{
    public User getUser(Long id);
}

@Service
public class MyBatisUserServiceImpl implements MyBatisUserService{
    //因為在啟動文件application.yaml配置了對應接口，所以直接依賴注入即可
    @Autowired
    private MyBatisUserDao myBatisUserDao = null;

    @Override
    public User getUser(Long id){
        return myBatisUserDao.getUser(id);
    }
}

3.1 配置模式

配置模式步驟如下。

1. 導入mybatis官方starter；

2. 編寫mapper接口，使用@Mapper或@MapperScan注解；

3. 配置全局配置文件（springboot自動配置好了）；

在resources/mybatis/mybatis-config.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
  PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <!-- 開啟駝峰命名匹配，或者在配置文件中配置 -->
    <settings>
        <setting name="mapUnderscoreToCamelCase" value="true"/>
    </settings>
</configuration>

配置mybatis.configuration下面的所有，就是相當於改mybatis全局配置文件中的值；

mybatis:
#注意：只能有一個全局配置，下面語句不能存在
#  config-location: classpath:mybatis/mybatis-config.xml
  mapper-locations: classpath:mybatis/mapper/*.xml
  configuration:
    map-underscore-to-camel-case: true  #推薦

4. 配置映射文件（編寫sql映射文件並綁定mapper接口）；

使用Mapper接口綁定Xml
在resources/mybatis/mapper/AccountMapper.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
  PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
  "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.dlhjw.admin.mapper.AccountMapper">

<!-- public Account getAcct(Long id) -->
    <select id="getAcct" resultType="com.dlhjw.admin.bean.Account">
        select * from account_tbl where id=#{id} 
    </select>
    
</mapper>

3.2 注解模式

注解模式步驟如下（自上而下分析，從數據層到表示層）。

@Select

選擇；
標注在mapper接口上；
用來代替原來xml里的<select>標簽，參數為原生的sql；

1. 導入mybatis官方starter；

2. 編寫mapper接口，使用@Mapper或@MapperScan注解；

3. 接口的方法上標注@Select注解，代替原來xml里的<select>標簽；

@Mapper
public interface CityMapper {
    @Select("select * from city where id=#{id}")
    public City getById(Long id);
}

4. 在service層里編寫業務方法；

public interface CityService {
     City getById(Long id);
}

@Service
public class CityServiceImpl implements CityService {

    @Autowired
    CityMapper cityMapper;
    
    public City getById(Long id){
        return cityMapper.getById(id);
    }
}

5. 在Controller層里編寫表示層相關方法；

*Controller相關知識參考下章。

@Controller
public class IndexController {

    @Autowired
    CityService cityService;

    @ResponseBody
    @GetMapping("/city")
    public City getCityById(@RequestParam("id") Long id){
        return cityService.getById(id);
    }
}

3.3 混合模式

混合模式步驟如下（自上而下分析，從數據層到表示層）。

1. 導入mybatis官方starter；

2. 編寫mapper接口，使用@Mapper或@MapperScan注解；

@Mapper
public interface CityMapper {

    @Select("select * from city where id=#{id}")
    public City getById(Long id);

    public void insert(City city);

}

3. 為insert方法配置xml文件；

<mapper namespace="com.atguigu.admin.mapper.CityMapper">

<!--  useGeneratedKeys:使用自增主鍵,可以返回自增主鍵值   keyProperty:自增屬性的id -->
   <insert id="insert" useGeneratedKeys="true" keyProperty="id">
        insert into  city(`name`,`state`,`country`) values(#{name},#{state},#{country})
   </insert>

</mapper>

4. 在service層里編寫業務方法；

public interface CityService {
     City getById(Long id);
     void saveCity(City city);
}

@Service
public class CityServiceImpl implements CityService {

    @Autowired
    CityMapper cityMapper;

    public City getById(Long id){
        return cityMapper.getById(id);
    }
    public void saveCity(City city) {
        counter.increment();
        cityMapper.insert(city);
    }
}

5. 在Controller層里編寫表示層相關方法；

*Controller相關知識參考下章。

@Controller
public class IndexController {

    @Autowired
    CityService cityService;

    @ResponseBody
    @PostMapping("/city")
    public City saveCity(City city){
        cityService.saveCity(city);
        return city;
    }

    @ResponseBody
    @GetMapping("/city")
    public City getCityById(@RequestParam("id") Long id){
        return cityService.getById(id);
    }
}

6. *將上述insert用注解方式改成注解模式

*此步驟不是必要的。

@Mapper
public interface CityMapper {
    @Insert("insert into  city(`name`,`state`,`country`) values(#{name},#{state},#{country})")
    @Options(useGeneratedKeys = true,keyProperty = "id")
    public void insert(City city);
}

@Insert

插入語句；
用在mapper接口上；
用來代替原來xml里的標簽，參數為原生的插入insert相關的sql；

@Options

選擇的參數；
用在mapper接口上；
用來代替原來xml里的標簽的參數配置，參數為相關的配置屬性；
useGeneratedKeys表示使用自增主鍵，可以返回自增主鍵值；keyProperty表示自增屬性的id。

4 總結

SpringBoot整合MyBatis的方法如下：

引入mybatis-starter；
配置application.yaml中，指定mapper-location位置即可；
編寫Mapper接口並標注@Mapper注解；
- 簡單方法直接注解方式；
- 復雜方法編寫mapper.xml進行綁定映射；
@MapperScan("com.dlhjw.admin.mapper") 簡化，其他的接口就可以不用標注@Mapper注解。

最后

新人制作，如有錯誤，歡迎指出，感激不盡！歡迎關注公眾號，會分享一些更日常的東西！如需轉載，請標注出處！

免責聲明！

本站轉載的文章為個人學習借鑒使用，本站對版權不負任何法律責任。如果侵犯了您的隱私權益，請聯系本站郵箱yoyou2525@163.com刪除。

猜您在找 SpringBoot的整合（三、整合mybatis） SpringBoot之SpringBoot整合MyBatis SpringBoot整合Shiro 三：整合Mybatis SpringBoot整合系列-整合MyBatis SpringBoot整合mybatis springboot + mybatis + mycat整合 SpringBoot 整合jdbc和mybatis SpringBoot整合mybatis springboot整合mybatis SpringBoot與Mybatis整合