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://github.com/fleyx/demo-project/tree/master/mybatis-test.