整合MyBatis之前,先搭建一个基本的Spring Boot项目开启Spring Boot。然后引入mybatis-spring-boot-starter和数据库连接驱动(这里使用关系型数据库Oracle 11g)。

mybatis-spring-boot-starter

在pom中引入:

  1. <dependency>
  2. <groupId>org.mybatis.spring.boot</groupId>
  3. <artifactId>mybatis-spring-boot-starter</artifactId>
  4. <version>1.3.1</version>
  5. </dependency>

不同版本的Spring Boot和MyBatis版本对应不一样,具体可查看官方文档:http://www.mybatis.org/spring-boot-starter/mybatis-spring-boot-autoconfigure/。

通过dependency:tree命令查看mybatis-spring-boot-starter都有哪些隐性依赖:

  1. +- org.mybatis.spring.boot:mybatis-spring-boot-starter:jar:1.3.1:compile
  2. | +- org.springframework.boot:spring-boot-starter-jdbc:jar:1.5.9.RELEASE:compile
  3. | | +- org.apache.tomcat:tomcat-jdbc:jar:8.5.23:compile
  4. | | | \- org.apache.tomcat:tomcat-juli:jar:8.5.23:compile
  5. | | \- org.springframework:spring-jdbc:jar:4.3.13.RELEASE:compile
  6. | | \- org.springframework:spring-tx:jar:4.3.13.RELEASE:compile
  7. | +- org.mybatis.spring.boot:mybatis-spring-boot-autoconfigure:jar:1.3.1:compile
  8. | +- org.mybatis:mybatis:jar:3.4.5:compile
  9. | \- org.mybatis:mybatis-spring:jar:1.3.1:compile

可发现其包含了spring-boot-starter-jdbc依赖,默认使用tomcat-jdbc数据源。

引入ojdbc

由于版权的原因,我们需要将ojdbc6.jar依赖安装到本地的maven仓库,然后才可以在pom中进行配置。

下载ojdbc6.jar文件后,将其放到比较好找的目录下,比如D盘根目录。然后运行以下命令:

  1. C:\Users\Administrator>mvn install:install-file -Dfile=D:/ojdbc6.jar -DgroupId=com.oracle -DartifactId=ojdbc6 -Dversion=6.0 -
  2. Dpackaging=jar -DgeneratePom=true
  3. ...
  4. [INFO] --- maven-install-plugin:2.4:install-file (default-cli) @ standalone-pom ---
  5. [INFO] Installing D:\ojdbc6.jar to D:\m2\repository\com\oracle\ojdbc6\6.0\ojdbc6-6.0.jar
  6. [INFO] Installing C:\Users\ADMINI~1\AppData\Local\Temp\mvninstall9103688544010617483.pom to D:\m2\repository\com\oracle\ojdbc
  7. 6\6.0\ojdbc6-6.0.pom
  8. [INFO] ------------------------------------------------------------------------
  9. [INFO] BUILD SUCCESS
  10. [INFO] ------------------------------------------------------------------------
  11. [INFO] Total time: 0.940 s
  12. [INFO] Finished at: 2017-08-13T15:06:38+08:00
  13. [INFO] Final Memory: 6M/145M
  14. [INFO] ------------------------------------------------------------------------

接着在pom中引入:

  1. <dependency>
  2. <groupId>com.oracle</groupId>
  3. <artifactId>ojdbc6</artifactId>
  4. <version>6.0</version>
  5. </dependency>

这里的groupid就是你之前安装时指定的-Dgroupid的值,artifactid就是你安装时指定的-Dartifactid的值,version也一样。

对于Oracle12c,引入ojdbc8:

  1. <!-- oracle驱动 -->
  2. <dependency>
  3. <groupId>com.oracle.database.jdbc</groupId>
  4. <artifactId>ojdbc8</artifactId>
  5. <version>21.1.0.0</version>
  6. </dependency>

Druid数据源

Druid是一个关系型数据库连接池,是阿里巴巴的一个开源项目,地址:https://github.com/alibaba/druid。Druid不但提供连接池的功能,还提供监控功能,可以实时查看数据库连接池和SQL查询的工作情况。

配置Druid依赖

Druid为Spring Boot项目提供了对应的starter:

  1. <dependency>
  2. <groupId>com.alibaba</groupId>
  3. <artifactId>druid-spring-boot-starter</artifactId>
  4. <version>1.1.10</version>
  5. </dependency>

Druid数据源配置

上面通过查看mybatis starter的隐性依赖发现,Spring Boot的数据源配置的默认类型是org.apache.tomcat.jdbc.pool.Datasource,为了使用Druid连接池,需要在application.yml下配置:

Oracle

springboot 1.x版本:(属性名的值和冒号中间必须有空格!)

  1. server:
  2. context-path: /web
  3. spring:
  4. datasource:
  5. druid:
  6. # 数据库访问配置, 使用druid数据源
  7. type: com.alibaba.druid.pool.DruidDataSource
  8. driver-class-name: oracle.jdbc.driver.OracleDriver
  9. url: jdbc:oracle:thin:@localhost:1521/xe
  10. username: scott
  11. password: tiger
  12. # 连接池配置
  13. initial-size: 5
  14. min-idle: 5
  15. max-active: 20
  16. # 连接等待超时时间
  17. max-wait: 30000
  18. # 配置检测可以关闭的空闲连接间隔时间
  19. time-between-eviction-runs-millis: 60000
  20. # 配置连接在池中的最小生存时间
  21. min-evictable-idle-time-millis: 300000
  22. validation-query: select '1' from dual
  23. test-while-idle: true
  24. test-on-borrow: false
  25. test-on-return: false
  26. # 打开PSCache,并且指定每个连接上PSCache的大小
  27. pool-prepared-statements: true
  28. max-open-prepared-statements: 20
  29. max-pool-prepared-statement-per-connection-size: 20
  30. # 配置监控统计拦截的filters, 去掉后监控界面sql无法统计, 'wall'用于防火墙
  31. filters: stat,wall
  32. # Spring监控AOP切入点,如x.y.z.service.*,配置多个英文逗号分隔
  33. aop-patterns: com.springboot.servie.*
  34. # WebStatFilter配置
  35. web-stat-filter:
  36. enabled: true
  37. # 添加过滤规则
  38. url-pattern: /*
  39. # 忽略过滤的格式
  40. exclusions: '*.js,*.gif,*.jpg,*.png,*.css,*.ico,/druid/*'
  41. # StatViewServlet配置
  42. stat-view-servlet:
  43. enabled: true
  44. # 访问路径为/druid时,跳转到StatViewServlet
  45. url-pattern: /druid/*
  46. # 是否能够重置数据
  47. reset-enable: false
  48. # 需要账号密码才能访问控制台
  49. login-username: druid
  50. login-password: druid123
  51. # IP白名单
  52. # allow: 127.0.0.1
  53. # IP黑名单(共同存在时,deny优先于allow)
  54. # deny: 192.168.1.218
  55. # 配置StatFilter
  56. filter:
  57. stat:
  58. log-slow-sql: true

上述配置不但配置了Druid作为连接池,而且还开启了Druid的监控功能。 其他配置可参考官方wiki——https://github.com/alibaba/druid/tree/master/druid-spring-boot-starter

MySQL

springboot 2.x版本连接MySQL:

  1. server:
  2. servlet:
  3. application-display-name: ProjectTemplate-Web
  4. context-path: /web
  5. spring:
  6. datasource:
  7. # 驱动配置信息
  8. db-type: com.alibaba.druid.pool.DruidDataSource
  9. #mysql 配置
  10. driver-class-name: com.mysql.cj.jdbc.Driver
  11. url: jdbc:mysql://localhost:3306/shop?useUnicode=true&characterEncoding=utf8&serverTimezone=GMT%2B8&useSSL=false
  12. username: test
  13. password: 12345678
  14. druid:
  15. ...
  16. # IP白名单,什么都不写表示都允许
  17. #Mac用 nslookup localhost 查看本地回环地址,不一定是127.0.0.1
  18. allow: localhost
  19. # IP黑名单(共同存在时,deny优先于allow)
  20. # deny: 192.168.1.218

注意 com.mysql.cj.jdbc.Driver对应mysql 5.x以上版本;com.mysql.jdbc.Driver 对应5.x以下

pom文件

  1. <dependency>
  2. <groupId>mysql</groupId>
  3. <artifactId>mysql-connector-java</artifactId>
  4. <version>8.0.11</version>
  5. </dependency>
  6. <dependency>
  7. <groupId>com.alibaba</groupId>
  8. <artifactId>druid-spring-boot-starter</artifactId>
  9. <version>1.1.20</version>
  10. </dependency>
  11. <dependency>
  12. <groupId>commons-dbutils</groupId>
  13. <artifactId>commons-dbutils</artifactId>
  14. <version>1.6</version>
  15. </dependency>

此时,运行项目,访问http://localhost:8080/web/druid

Spring Boot中使用MyBatis - 图1

输入账号密码即可看到Druid监控后台:

Spring Boot中使用MyBatis - 图2

关于Druid的更多说明,可查看官方wiki——https://github.com/alibaba/druid/wiki/%E5%B8%B8%E8%A7%81%E9%97%AE%E9%A2%98

MySQL 8.0 注意事项

注意我目前用的MySQL 8.0.15,据网上所说,5.x版本和8.x的加密方式区别如下:

  • 5.X版本是:default_authentication_plugin=mysql_native_password
  • 8.x版本就是:default_authentication_plugin=caching_sha2_password

此时pom文件依赖中mysql-connector-java请使用8.x版本,否则报错 Unable to load authentication plugin ‘caching_sha2_password’

在使用 MySQL 8.0 时重启应用后提示 com.mysql.jdbc.exceptions.jdbc4.MySQLNonTransientConnectionException: Public Key Retrieval is not allowed

最简单的解决方法是在连接后面添加 &allowPublicKeyRetrieval=true

文档中给出的解释是:

如果用户使用了 sha256_password 认证,密码在传输过程中必须使用 TLS 协议保护,但是如果 RSA 公钥不可用,可以使用服务器提供的公钥。可以在连接中通过 ServerRSAPublicKeyFile 指定服务器的 RSA 公钥,或者AllowPublicKeyRetrieval=True参数以允许客户端从服务器获取公钥;但是需要注意的是 AllowPublicKeyRetrieval=True可能会导致恶意的代理通过中间人攻击(MITM)获取到明文密码,所以默认是关闭的,必须显式开启

Spring Boot中使用MyBatis - 图3

使用MyBatis

使用的库表:

  1. CREATE TABLE "SCOTT"."STUDENT" (
  2. "SNO" VARCHAR2(3 BYTE) NOT NULL ,
  3. "SNAME" VARCHAR2(9 BYTE) NOT NULL ,
  4. "SSEX" CHAR(2 BYTE) NOT NULL
  5. );
  6. INSERT INTO "SCOTT"."STUDENT" VALUES ('001', 'KangKang', 'M ');
  7. INSERT INTO "SCOTT"."STUDENT" VALUES ('002', 'Mike', 'M ');
  8. INSERT INTO "SCOTT"."STUDENT" VALUES ('003', 'Jane', 'F ');

创建对应实体:

  1. public class Student implements Serializable{
  2. private static final long serialVersionUID = -339516038496531943L;
  3. private String sno;
  4. private String name;
  5. private String sex;
  6. // get,set略
  7. }

创建一个包含基本CRUD的StudentMapper:

  1. public interface StudentMapper {
  2. int add(Student student);
  3. int update(Student student);
  4. int deleteByIds(String sno);
  5. Student queryStudentById(Long id);
  6. }

StudentMapper的实现可以基于xml也可以基于注解。

使用注解方式

继续编辑StudentMapper:

  1. @Component
  2. @Mapper
  3. public interface StudentMapper {
  4. @Insert("insert into student(sno,sname,ssex) values(#{sno},#{name},#{sex})")
  5. int add(Student student);
  6. @Update("update student set sname=#{name},ssex=#{sex} where sno=#{sno}")
  7. int update(Student student);
  8. @Delete("delete from student where sno=#{sno}")
  9. int deleteBysno(String sno);
  10. @Select("select * from student where sno=#{sno}")
  11. @Results(id = "student",value= {
  12. @Result(property = "sno", column = "sno", javaType = String.class),
  13. @Result(property = "name", column = "sname", javaType = String.class),
  14. @Result(property = "sex", column = "ssex", javaType = String.class)
  15. })
  16. Student queryStudentBySno(String sno);

简单的语句只需要使用@Insert、@Update、@Delete、@Select这4个注解即可,动态SQL语句需要使用@InsertProvider、@UpdateProvider、@DeleteProvider、@SelectProvider等注解。具体可参考MyBatis官方文档:http://www.mybatis.org/mybatis-3/zh/java-api.html

使用xml方式

使用xml方式需要在application.yml中进行一些额外的配置:

  1. mybatis:
  2. # type-aliases扫描路径
  3. # type-aliases-package:
  4. # mapper xml实现扫描路径
  5. mapper-locations: classpath:mapper/*.xml
  6. property:
  7. order: BEFORE

测试

接下来编写Service:

  1. public interface StudentService {
  2. int add(Student student);
  3. int update(Student student);
  4. int deleteBysno(String sno);
  5. Student queryStudentBySno(String sno);
  6. }

实现类:

  1. @Service("studentService")
  2. public class StudentServiceImp implements StudentService{
  3. @Autowired
  4. private StudentMapper studentMapper;
  5. @Override
  6. public int add(Student student) {
  7. return this.studentMapper.add(student);
  8. }
  9. @Override
  10. public int update(Student student) {
  11. return this.studentMapper.update(student);
  12. }
  13. @Override
  14. public int deleteBysno(String sno) {
  15. return this.studentMapper.deleteBysno(sno);
  16. }
  17. @Override
  18. public Student queryStudentBySno(String sno) {
  19. return this.studentMapper.queryStudentBySno(sno);
  20. }
  21. }

编写controller:

  1. @RestController
  2. public class TestController {
  3. @Autowired
  4. private StudentService studentService;
  5. @RequestMapping( value = "/querystudent", method = RequestMethod.GET)
  6. public Student queryStudentBySno(String sno) {
  7. return this.studentService.queryStudentBySno(sno);
  8. }
  9. }

完整的项目目录如下图所示:

Spring Boot中使用MyBatis - 图4

启动项目访问:http://localhost:8080/web/querystudent?sno=001

Spring Boot中使用MyBatis - 图5

查看SQL监控情况:

Screen Shot 2021-09-22 at 7.14.47 PM.png

可看到其记录的就是刚刚访问/querystudent得到的SQL。

相关注解

@Mapper注解:

作用:在接口类上添加了@Mapper,在编译之后会生成相应的接口实现类

添加位置:接口类上面

  1. @Mapper
  2. public interface UserDAO {
  3. //代码
  4. }

如果想要每个接口都要变成实现类,那么需要在每个接口类上加上@Mapper注解,比较麻烦,解决这个问题用@MapperScan

@MapperScan

作用:指定要变成实现类的接口所在的包,然后包下面的所有接口在编译之后都会生成相应的实现类

添加位置:是在Springboot启动类上面添加,

  1. @SpringBootApplication
  2. @MapperScan("com.winter.dao")
  3. public class SpringbootMybatisDemoApplication {
  4. public static void main(String[] args) {
  5. SpringApplication.run(SpringbootMybatisDemoApplication.class, args);
  6. }
  7. }

添加@MapperScan(“com.winter.dao”)注解以后,com.winter.dao包下面的接口类,在编译之后都会生成相应的实现类

使用@MapperScan注解多个包(实际用的时候根据自己的包路径进行修改)

  1. @SpringBootApplication
  2. @MapperScan({"com.kfit.demo","com.kfit.user"})
  3. public class App {
  4. public static void main(String[] args) {
  5. SpringApplication.run(App.class, args);
  6. }
  7. }

如果dao接口类没有在Spring Boot主程序可以扫描的包或者子包下面,可以使用如下方式进行配置:
(没验证过,不确定能否使用,或许需要根据自己定义的包名进行修改路径)

  1. @SpringBootApplication
  2. @MapperScan({"com.kfit.*.mapper","org.kfit.*.mapper"})
  3. public class App {
  4. public static void main(String[] args) {
  5. SpringApplication.run(App.class, args);
  6. }
  7. }