springboot使用Mybatis(xml和注解)全解析

​  剛畢業的第一份工作是 java 開發，項目中需要用到 mybatis，特此記錄學習過程，這只是一個簡單 demo，mybatis 用法很多不可能全部寫出來，有更復雜的需求建議查看 mybatis 的官方中文文檔，點擊跳轉。下面時項目環境/版本。

• 開發工具：IDEA
• jdk 版本：1.8
• springboot 版本：2.03

其他依賴版本見下面 pom.xml:

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.example</groupId>
    <artifactId>mybatis-test</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <packaging>jar</packaging>

    <name>mybatis-test</name>
    <description>Demo project for Spring Boot</description>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.0.3.RELEASE</version>
        <relativePath/> <!-- lookup parent from repository -->
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        <!--mybatis依賴 -->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>1.3.2</version>
        </dependency>
        <!--alibaba連接池依賴-->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid-spring-boot-starter</artifactId>
            <version>1.1.9</version>
        </dependency>
        <!--分頁依賴-->
        <dependency>
            <groupId>com.github.pagehelper</groupId>
            <artifactId>pagehelper-spring-boot-starter</artifactId>
            <version>1.2.5</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

1.創建項目

​ 使用 idea 中的 spring initializr 生成 maven 項目，項目命令為 mybatis-test，選擇 web，mysql，mybatis 依賴，即可成功。（詳細過程不贅述，如有需要學習 springboot 創建過程，可參考這篇文章。

​ 然后依照上面的 pom 文件，補齊缺少的依賴。接着創建包 entity，service 和 mybatis 映射文件夾 mapper，創建。為了方便配置將 application.properties 改成 application.yml。由於我們時 REST 接口，故不需要 static 和 templates 目錄。修改完畢后的項目結構如下：

  修改啟動類，增加@MapperScan("com.example.mybatistest.dao"),以自動掃描 dao 目錄，避免每個 dao 都手動加@Mapper注解。代碼如下：

@SpringBootApplication
@MapperScan("com.example.mybatistest.dao")
public class MybatisTestApplication {
    public static void main(String[] args) {
        SpringApplication.run(MybatisTestApplication.class, args);
    }
}

修改 application.yml,配置項目，代碼如下：

mybatis:
  #對應實體類路徑
  type-aliases-package: com.example.mybatistest.entity
  #對應mapper映射文件路徑
  mapper-locations: classpath:mapper/*.xml

#pagehelper物理分頁配置
pagehelper:
  helper-dialect: mysql
  reasonable: true
  support-methods-arguments: true
  params: count=countSql
  returnPageInfo: check

server:
  port: 8081

spring:
  datasource:
    name: mysqlTest
    type: com.alibaba.druid.pool.DruidDataSource
    #druid連接池相關配置
    druid:
      #監控攔截統計的filters
      filters: stat
      driver-class-name: com.mysql.jdbc.Driver
      url: jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf-8&useSSL=true
      username: root
      password: 123456
      #配置初始化大小，最小，最大
      initial-size: 1
      min-idle: 1
      max-active: 20
      #獲取連接等待超時時間
      max-wait: 6000
      #間隔多久檢測一次需要關閉的空閑連接
      time-between-eviction-runs-millis: 60000
      #一個連接在池中的最小生存時間
      min-evictable-idle-time-millis: 300000
      #打開PSCache，並指定每個連接上PSCache的大小。oracle設置為true，mysql設置為false。分庫分表設置較多推薦設置
      pool-prepared-statements: false
      max-pool-prepared-statement-per-connection-size: 20
  http:
    encoding:
      charset: utf-8
      enabled: true

2.編寫代碼

​ 首先創建數據表，sql 語句如下：

CREATE TABLE `user` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `name` varchar(255) NOT NULL,
  `age` tinyint(4) NOT NULL DEFAULT '0',
  `password` varchar(255) NOT NULL DEFAULT '123456',
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=0 DEFAULT CHARSET=utf8;

​ 然后在 entity 包中創建實體類 User.java

public class User {
    private int id;
    private String name;
    private int age;
    private String password;

    public User(int id, String name, int age, String password) {
        this.id = id;
        this.name = name;
        this.age = age;
        this.password = password;
    }
    public User(){}
    //getter setter自行添加
}

​ 在 dao 包下創建 UserDao.java

public interface UserDao {
    //插入用戶
    int insert(User user);
    //根據id查詢
    User selectById(String id);
    //查詢所有
    List<User> selectAll();
}

​ 在 mapper 文件夾下創建 UserMapper.xml,具體的 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.example.mybatistest.dao.UserDao">
    <sql id="BASE_TABLE">
        user
    </sql>
    <sql id="BASE_COLUMN">
        id,name,age,password
    </sql>

    <insert id="insert" parameterType="com.example.mybatistest.entity.User" useGeneratedKeys="true" keyProperty="id">
        INSERT INTO <include refid="BASE_TABLE"/>
        <trim prefix="(" suffix=")" suffixOverrides=",">
            name,password,
            <if test="age!=null">
                age
            </if>
        </trim>
        <trim prefix=" VALUE(" suffix=")" suffixOverrides=",">
            #{name,jdbcType=VARCHAR},#{password},
            <if test="age!=null">
                #{age}
            </if>
        </trim>
    </insert>

    <select id="selectById" resultType="com.example.mybatistest.entity.User">
        select
          <include refid="BASE_COLUMN"/>
        from
          <include refid="BASE_TABLE"/>
        where id=#{id}
    </select>

    <select id="selectAll" resultType="com.example.mybatistest.entity.User">
        select
          <include refid="BASE_COLUMN"/>
        from
          <include refid="BASE_TABLE"/>
    </select>
</mapper>

​ 至此使用 mybatis 的代碼編寫完了，之后要用時調用 dao 接口中的方法即可。

3.測試

​ 我們通過編寫 service，controller 然后使用 postman 進行測試。

​ 首先編寫 UserService.java,代碼如下：

@Component
public class UserService {

    @Autowired
    private UserDao userDao;

    public User getByUserId(String id){
        return userDao.selectById(id);
    }
    //獲取全部用戶
    public List<User> getAll(){
        return userDao.selectAll();
    }
    //測試分頁
    public PageInfo<User> getAll(int pageNum,int pageSize){
        PageHelper.startPage(pageNum,pageSize);
        List<User> users = userDao.selectAll();
        System.out.println(users.size());
        PageInfo<User> result = new PageInfo<>(users);
        return result;
    }

    public int insert(User user){
        return userDao.insert(user);
    }

}

​ 編寫 UserController.java

@RestController
public class UserController {

    @Autowired
    private UserService userService;

    @GetMapping("/user/{userId}")
    public User getUser(@PathVariable String userId){
        return userService.getByUserId(userId);
    }

    @GetMapping("/user")
    public List<User> getAll(){
        return userService.getAll();
    }

    @GetMapping("/user/page/{pageNum}")
    public Object getPage(@PathVariable int pageNum,
                          @RequestParam(name = "pageSize",required = false,defaultValue = "10") int pageSize){
        return userService.getAll(pageNum,pageSize);
    }

    @PostMapping("/user")
    public Object addOne(User user){
        userService.insert(user);
        return user;
    }
}

​ 啟動項目，通過 postman 進行請求測試，測試結果如下：

• 插入數據：

• 查詢數據

• 分頁查詢

4.注解編寫 sql

​ 上面使用的是 xml 方式編寫 sql 代碼，其實 mybatis 也支持在注解中編寫 sql，這樣可以避免編寫復雜的 xml 查詢文件，但同時也將 sql 語句耦合到了代碼中，也不易實現復雜查詢，因此多用於簡單 sql 語句的編寫。

​ 要使用注解首先將 applicaton.yml 配置文件中的mapper-locations: classpath:mapper/*.xml注釋掉。然后在 UserDao.java 中加入 sql 注解，代碼如下：

public interface UserDao {
    //插入用戶
    @Insert("insert into user(name,age,password) value(#{name},#{age},#{password})")
    @Options(useGeneratedKeys=true,keyColumn="id",keyProperty="id")
    int insert(User user);
    //根據id查詢
    @Select("select * from user where id=#{id}")
    User selectById(String id);
    //查詢所有
    @Select("select * from user")
    List<User> selectAll();
}

然后重新啟動項目測試，測試結果跟上面完全一樣。

本文原創發布於：https://www.tapme.top/blog/detail/2018-09-01-10-38

源碼地址：https://github.com/FleyX/demo-project/tree/master/mybatis-test.