Mybatis和其他主流框架的整合使用

Mybatis簡介

MyBatis歷史

• MyBatis最初是Apache的一個開源專案iBatis, 2010年6月這個專案由Apache Software Foundation遷移到了Google Code。隨著開發團隊轉投Google Code旗下，iBatis3.x正式更名為MyBatis。程式碼於2013年11月遷移到Github

• iBatis一詞來源於“internet”和“abatis”的組合，是一個基於Java的持久層框架。iBatis提供的持久層框架包括SQL Maps和Data Access Objects（DAO）

MyBatis特性

1. MyBatis 是支援定製化 SQL、儲存過程以及高階對映的優秀的持久層框架

2. MyBatis 避免了幾乎所有的 JDBC 程式碼和手動設定引數以及獲取結果集

3. MyBatis可以使用簡單的XML或註解用於配置和原始對映，將介面和Java的POJO（Plain Old Java Objects，普通的Java物件）對映成資料庫中的記錄

4. MyBatis 是一個 半自動的ORM（Object Relation Mapping）框架

 

1、在Maven專案中使用Mybatis

　　先建立一個普通的Maven專案，然後在pom.xml檔案中引入Mybatis的依賴，因為要連線資料庫，所以還需要引入資料庫連線的依賴

<dependencies>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.5.10</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.33</version>
        </dependency>
    </dependencies>

　　要使用Mybatis需要配置Mybatis的核心配置，在resources資原始檔夾下建立一個mybatis配置檔案（名字隨意），並寫入配置，配置參考Mybatis官方文件mybatis – MyBatis 3 | 入門

 　

　在資料來源<dataSource>的配置中,配置好driver,url,username,password

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
        PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
        "https://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
    <environments default="development">
        <environment id="development">
            <transactionManager type="JDBC"/>
            <dataSource type="POOLED">
                <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3307/mybatis"/>
                <property name="username" value="root"/>
                <property name="password" value="root"/>
            </dataSource>
        </environment>
    </environments>
    <!--<mappers>
        <mapper resource="org/mybatis/example/BlogMapper.xml"/>
    </mappers>-->
</configuration>

　　習慣上命名為mybatis-config.xml，這個檔名僅僅只是建議，並非強制要求。將來整合Spring之後，這個配置檔案可以省略，所以大家操作時可以直接複製、貼上。 核心配置檔案主要用於配置連線資料庫的環境以及MyBatis的全域性配置資訊 核心配置檔案存放的位置是src/main/resources目錄下

 

　　現在需要一個資料庫和表和一些資料用做連線測試

CREATE DATABASE IF NOT EXISTS `mybatis` DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;

CREATE TABLE USER(
     `id` INT UNSIGNED PRIMARY KEY AUTO_INCREMENT COMMENT 'ID',
     `name` VARCHAR(100) COMMENT '姓名',
     `age` TINYINT UNSIGNED COMMENT '年齡',
     `gender` TINYINT UNSIGNED COMMENT '性別, 1:男, 2:女',
     `phone` VARCHAR(11) COMMENT '手機號'
) COMMENT '使用者表';

INSERT INTO USER(id, NAME, age, gender, phone) VALUES (NULL,'白眉鷹王',55,'1','18800000000');
INSERT INTO USER(id, NAME, age, gender, phone) VALUES (NULL,'金毛獅王',45,'1','18800000001');
INSERT INTO USER(id, NAME, age, gender, phone) VALUES (NULL,'青翼蝠王',38,'1','18800000002');
INSERT INTO USER(id, NAME, age, gender, phone) VALUES (NULL,'紫衫龍王',42,'2','18800000003');
INSERT INTO USER(id, NAME, age, gender, phone) VALUES (NULL,'光明左使',37,'1','18800000004');
INSERT INTO USER(id, NAME, age, gender, phone) VALUES (NULL,'光明右使',48,'1','18800000005');

　　構建整體專案結構controller、service、mapper三層架構，建立一個實體類對應資料庫的表結構，建立MyBatis的對映檔案xxxMapper.xml

• 對映檔案的命名規則

• 表所對應的實體類的類名+Mapper.xml

• 例如：表t_user，對映的實體類為User，所對應的對映檔案為UserMapper.xml

• 因此一個對映檔案對應一個實體類，對應一張表的操作

• MyBatis對映檔案用於編寫SQL，訪問以及操作表中的資料

• MyBatis對映檔案存放的位置是src/main/resources/mappers目錄下

 

在resources檔案目錄下建立mapper的時候需要和main檔案目錄下的mapper同包名，在建立directory的時候，目錄結構不能使用點，而是用/代替

 

User實體類中的屬性需要和表中的欄位名相對應，這裡也可以用Lombok註解

 

 　　mapper介面的全類名和對映檔案的名稱空間（namespace）保持一致、mapper介面中方法的方法名和對映檔案中編寫SQL的標籤的id屬性保持一致

　　然後在mapper中寫我們需要的語句，查詢語句用<select>、增加語句用<insert>、刪除語句用<delete>、修改語句用<update>標籤，返回型別resultType要和實體類中的實體類名稱對應

 

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "https://mybatis.org/dtd/mybatis-3-mapper.dtd">

<mapper namespace="mapper.UserMapper">

    <select id="selectAll" resultType="pojo.User">
        SELECT id, name, age, gender, phone FROM user
    </select>
</mapper>

 

 　　寫好了之後回到mybatis-config.xml中配置一下mapper對映

 

　　在UserMapper中將UserMapper.xml中配置好的方法宣告一下，方法名要和上面的id對應上

 

　　在service層寫好業務邏輯程式碼，在介面中宣告方法，在實現類中實現方法

public class UserServiceImpl implements UserService {

    @Override
    public List<User> selectAll() throws IOException {
        //讀取MyBatis的核心配置檔案
        InputStream is = Resources.getResourceAsStream("mybatis-config.xml");
        //獲取SqlSessionFactoryBuilder物件
        SqlSessionFactoryBuilder sqlSessionFactoryBuilder = new SqlSessionFactoryBuilder();
        //透過核心配置檔案所對應的位元組輸入流建立工廠類SqlSessionFactory，生產SqlSession物件
        SqlSessionFactory sqlSessionFactory = sqlSessionFactoryBuilder.build(is);
        //獲取sqlSession，此時透過SqlSession物件所操作的sql都必須手動提交或回滾事務
        SqlSession sqlSession = sqlSessionFactory.openSession();
        //透過代理模式建立UserMapper介面的代理實現類物件
        UserMapper mapper = sqlSession.getMapper(UserMapper.class);
        //呼叫UserMapper介面中的方法，就可以根據UserMapper的全類名匹配元素檔案，透過呼叫的方法名匹配對映檔案中的SQL標籤，並執行標籤中的SQL語句
        List<User> users = mapper.selectAll();
        return users;
    }
}

 

 　　在controller層中寫好處理結果程式碼

public class UserController {
    private UserService userService = new UserServiceImpl();
    
    public void selectAll() throws IOException {
        List<User> users = userService.selectAll();
        users.forEach(System.out::println);
    }
}

 

　　建立一個Test類去測試mybatis資料庫連線，因為沒有引入單元測試依賴，所以這裡用主函式去測試

 　　發現結果成功輸出列印

　　

　　如果SQL語句比較簡單，可以使用mybatis中的註解，查詢語句用@Select、增加語句用@Insert、刪除語句用@Delete、修改語句用@Update註解

在裡面寫上sql語句，再執行發現，也可以查詢成功。

 　　當然，複雜一點的sql語句和動態SQL建議還是使用Mapper配置，只是簡單的sql語句寫在註解裡面可以簡化，複雜的sql只會增加程式碼的複雜度

總結

　　在Maven專案中，使用mybatis需要先匯入mybatis依賴和連線資料庫的依賴，然後建立mybatis配置檔案，在配置檔案中配置資料來源細資訊，隨後建立MyBatis的對映檔案Mapper，在mapper檔案中寫好對應的語句，然後在業務層進行SqlSession連線，呼叫mapper中的方法，再在controller層處理返回方法。

 

2、用Spring框架整合Mybatis

　　同樣的先建立一個Maven專案，然後在pom.xml檔案中引入Spring的依賴，Mybatis的依賴，資料庫連線依賴，druid連線池依賴，spring-mybatis依賴，spring-jdbc依賴。

<dependencies>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis</artifactId>
            <version>3.5.10</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.33</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-context</artifactId>
            <version>5.3.30</version>
        </dependency>
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.2.20</version>
        </dependency>
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis-spring</artifactId>
            <version>1.3.2</version>
        </dependency>
        <dependency>
            <groupId>org.springframework</groupId>
            <artifactId>spring-jdbc</artifactId>
            <version>5.3.2</version>
        </dependency>
    </dependencies>

 

　　構建整體專案結構

 

2.1、基於XML整合Mybatis

• 匯入Mybatis整合Spring的相關座標
• 編寫Mapper和Mapper.xml
• 配置SqlSessionFactoryBean和MapperScannerConfigurer
• 編寫測試程式碼

 

　　

　　和上面步驟相同，編寫Mapper和Mapper.xml，一定要放在相同路徑下

　　

　　在UserMapper.xml中寫我們需要的語句，並在UserMapper介面中寫對應id的方法宣告；

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "https://mybatis.org/dtd/mybatis-3-mapper.dtd">

<mapper namespace="mapper.UserMapper">

    <select id="selectAll" resultType="pojo.User">
        SELECT id, name, age, gender, phone FROM user
    </select>
</mapper>

public interface UserMapper {

    List<User> selectAll();
}

　　同樣的，簡單的SQL語句也可以用@Select註解編寫，不需要UserMapper.xml配置 　　

 

　　在Spring配置檔案中配置SqlSessionFactoryBean

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">

    <!--配置SqlSessionFactoryBean，作用將SqlSessionFactory儲存到spring容器-->
    <bean class="org.mybatis.spring.SqlSessionFactoryBean">
        <property name="dataSource" ref="dataSource"></property>
    </bean>

    <!--配置資料來源資訊-->
    <bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource">
        <property name="driverClassName" value="com.mysql.cj.jdbc.Driver"></property>
        <property name="url" value="jdbc:mysql://localhost:3307/mybatis"></property>
        <property name="username" value="root"></property>
        <property name="password" value="root"></property>
    </bean>
</beans>

　　對應的是之前配置檔案中的

 <dataSource type="POOLED">
                <property name="driver" value="com.mysql.cj.jdbc.Driver"/>
                <property name="url" value="jdbc:mysql://localhost:3307/mybatis"/>
                <property name="username" value="root"/>
                <property name="password" value="root"/>
</dataSource>

 

　　在Spring配置檔案中配置MapperScannerConfigurer

<!--MapperScannerConfigurer,作用掃描指定的包，產生Mapper物件儲存到Spring容器-->
    <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <property name="basePackage" value="mapper"></property>
    </bean>

　　對應的是

<mappers>
        <package name="com.tedu.mapper"/>
</mappers>

　　在Spring配置檔案中配置好之後，在使用的時候就不用手動建立了，直接注入即可。

 

　　在UserServiceImpl屬性中新增UserMapper，併為其新增setter方法用於注入。

public class UserServiceImpl implements UserService {
    private UserMapper userMapper;

    public void setUserMapper(UserMapper userMapper) {
        this.userMapper = userMapper;
    }

    @Override
    public List<User> selectAll() {
        return userMapper.selectAll();
    }
}

 

　　同樣，在UserController屬性中新增UserService，併為其新增setter方法用於注入。在selectAll方法中處理返回的結果。

public class UserController {
    private UserService userService;

    public void setUserService(UserService userService) {
        this.userService = userService;
    }
    
    public void selectAll(){
        List<User> users = userService.selectAll();
        users.forEach(System.out::println);
    }
}

 

　　在Spring配置檔案中配置上述UserService和UserController用於注入

<bean id="userServiceImpl" class="service.impl.UserServiceImpl">
        <property name="userMapper" ref="userMapper"></property>
    </bean>
    
    <bean id="userContorller" class="controller.UserController">
        <property name="userService" ref="userServiceImpl"></property>
    </bean>

 

　　最後建立一個測試類進行資料庫連線測試

public class TestSelectAll {
    public static void main(String[] args) {
        ApplicationContext context = new ClassPathXmlApplicationContext("application.xml");
        UserController userController = context.getBean(UserController.class);
        userController.selectAll();
    }
}

　　可以在控制檯看到列印的結果

 

總結

　　基於XML方式整合Mybatis首先需要建立Spring的配置檔案，在XML配置檔案中去配置bean，將bean物件交由Spring容器管理，其餘的mapper和普通方法一樣。需要配置資料來源DataSource，配置SqlSessionFactoryBean、配置MapperScannerConfigurer，再配置UserMapper、UserService和UserController。在測試類中用ClassPathXmlApplicationContext和getBean獲取到UserContorller物件再呼叫其方法即可。這種方式不用編寫mybatis-config.xml配置檔案，在Spring配置檔案中全部配置了，雖然簡化了部分操作，但是還是較為繁瑣，下面講一種用註解方式整合mybatis。

 

2.2、基於註解整合Mybatis

　　匯入和上述基於XML整合mybatis方法相同的依賴

　　再構建同樣的專案結構

 

　　還需要在resources資源目錄下面新增一個配置檔案用於存放資料來源配置資訊

jdbc.driver=com.mysql.cj.jdbc.Driver
jdbc.username=root
jdbc.password=root
jdbc.url=jdbc:mysql://localhost:3307/mybatis

 

　　除了像上面方法構建的專案結構之外，還需要一個配置類進行配置

@Configuration
@ComponentScan("cn.test")
@PropertySource("classpath:jdbc.properties")
@MapperScan("cn.test.mapper")
public class MybatisConfig {

    @Bean
    public DataSource dataSource(
            @Value("${jdbc.driver}") String driver,
            @Value("${jdbc.username}") String username,
            @Value("${jdbc.password}") String passwrod,
            @Value("${jdbc.url}") String url
    ){
        DruidDataSource dataSource = new DruidDataSource();
        dataSource.setDriverClassName(driver);
        dataSource.setUsername(username);
        dataSource.setPassword(passwrod);
        dataSource.setUrl(url);
        return dataSource;
    }

    @Bean
    public SqlSessionFactoryBean sqlSessionFactoryBean(@Autowired DataSource dataSource){
        SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
        sqlSessionFactoryBean.setDataSource(dataSource);
        return sqlSessionFactoryBean;
    }
}

　　@Configuration註解是宣告該類是一個配置類

　　@ComponentScan註解是包掃描，掃描該包和該包的子孫包中的類帶有@Component註解的類，交由Spring容器管理

　　@PropertySource註解是設定資原始檔目錄，classpath後是properties檔案的路徑，載入後可以用${}佔位符獲取properties檔案中的屬性

　　@MapperScan註解是設定Mapper檔案掃描，相當於mybatis配置檔案中<mapper>標籤

　　配置檔案中用@Bean註解配置非自定義Bean的配置，在dataSource方法中傳入連線資料庫四要素並且用@Value註解去注入值，其中用${}佔位符獲取properties檔案中的屬性，最後方法返回dataSource，同樣的用sqlSessionFactoryBean方法sqlSessionFactoryBean，在引數中用@AutoWried注入dataSource引數，其中@AuroWired註解可省略，最後方法返回sqlSessionFactoryBean。

　　這樣，在Config配置檔案中就完成了SqlSessionFactoryBean和MapperScannerConfigurer的配置

 

　　接下來就是編寫UserMapper和UserMapper.xml檔案，這裡就不在用XML配置檔案進行演示，如需要，上面的其他方法都有演示，這裡就用註解的方式編寫SQL語句。

 

　　隨後，編寫三層架構的程式碼，在UserController中，用@AuroWired註解自動注入UserService，並且在類上加上@Controller註解，表示該類是Contriller層類並交由Spring容器管理

@Controller
public class UserController {
    @Autowired
    private UserService userService;

    public void findAll() {
        List<User> all = userService.findAll();
        all.forEach(System.out::println);
    }
}

　　在UserServiceImpl中用，@AuroWired註解自動注入UserMapper，並且在類上加上@Service註解，表示該類是Service層類並交由Spring容器管理

@Service
public class UserServiceImpl implements UserService {

    @Autowired
    private UserMapper userMapper;
    @Override
    public List<User> findAll() {
        return userMapper.findAll();
    }
}

　　在UserMapper中，編寫SQL方法，用@Select註解編寫SQL語句，因為在配置檔案中加了@MapperScan("cn.test.mapper")註解，所以在此類上不需要加任何Component註解

public interface UserMapper {
    @Select("SELECT id, name, age, gender, phone FROM user")
    List<User> findAll();
}

 

　　最後，編寫測試方法進行資料庫連線測試

public class TestAnnoMyBatis {
    public static void main(String[] args) {
        ApplicationContext context = new AnnotationConfigApplicationContext(MybatisConfig.class);
        UserController userController = context.getBean(UserController.class);
        userController.findAll();
    }
}

　　在測試方法中用AnnotationConfigApplicationContext方法載入MybatisConfig配置檔案，同樣在控制檯中可以看到成功輸出結果

 

總結

　　基於註解整合Mybatis方法中，我們不需要配置任何XML檔案，其他操作基本相同，只需要新增一個配置檔案，在配置檔案中用一些註解和方法去完成配置。同時，在管理Bean時，也是用註解去自動裝配，交由Spring容器去管理。大大簡化了配置。

 

3、SpringBoot整合Mybatis

　　用SpringBoot框架整合Mybatis相對就較為簡單了

　　首先建立於一個SpringBoot專案

 　　

　　在勾選依賴的時候，需要勾選MyBatisFarmework依賴和MySql依賴進行資料的連線和Mybatis的使用

 

　　建立完成之後在application.properties配置檔案中配置資料來源

spring.datasource.url=jdbc:mysql://localhost:3307/mybatis?serverTimezone=Asia/Shanghai&characterEncoding=utf8
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

 

　　然後在UserMapper中開始寫SQL語句

@Mapper
public interface UserMapper {

    @Select("SELECT id, name, age, gender, phone FROM user")
    List<User> userList();
}

　　一定要在UserMapper類上加上@Mapper註解，@Mapper註解是識別他為mybatis的mapper介面，會自動的把 加@Mapper 註解的介面生成動態代理類。

 

　　同樣的，在UserService中用@AutoWired對UserMapper進行注入，並在該類上加上@Service註解

@Service
public class UserServiceImpl implements UserService {
    @Autowired
    private UserMapper userMapper;

    public List<User> userList(){
        return userMapper.userList();
    }
}

 

　　在UserController中用@AutoWired對UserService進行注入並處理返回的結果，並在該類上加上@Controiller註解

@Controller
public class UserController {
    @Autowired
    private UserService userService;

    public void userList(){
        List<User> users = userService.userList();
        users.forEach(System.out::println);
    }
}

 

　　最後在SpringBoot的測試類中寫一個測試方法進行資料庫連線的測試

@SpringBootTest
class SpringBootMybatisApplicationTests {
    
    @Autowired
    private UserController userController;
    @Test
    public void test(){
        userController.userList();
    }

}

　　可以看到控制檯成功輸出結果

 

總結

　　使用SpringBoot框架整合Mybatis更為簡單，只需要在application.properties配置檔案中配置資料來源四要素就行，隨後就可以直接在Mapper中寫SQL語句，最後可以在SpringBootTest類中直接進行測試。