集成Springboot+MyBatis+JPA

提示：扫一扫查出行
【扫一扫了解最新限行尾号】
复制提示

1.前言

Springboot最近可谓是非常的火，本人也在项目中尝到了甜头。之前一直使用Springboot+JPA，用了一段时间发现JPA不是太灵活，也有可能是我不精通JPA，总之为了多学学Springboot我决定尝试一下Springboot+MyBatis+JPA三项集成，集成过程中遇到了很多问题，但最后总算是集成成功了，现在记录一下方法。

1.1 如何使用MyBatis Generator自动生成xxxMapper.java接口以及xxxMapper.xml文件

以前用过SpringMVC，知道写xxxMapper.java接口以及xxxMapper.xml文件的辛苦，这次集成最先想到的就是先解决如何使用如何使用MyBatis Generator自动生成这些文件的问题。

先扔出MyBatis Generator的官网->请戳这里

我使用的Maven集成插件的方式，IDE使用的是IDEA

1.1.1 创建项目

20180126110629.png

20180126110757.png

20180126110812.png

1.1.2 修改pom.xml

添加了Druid依赖和MyBatis Generator插件

其他依赖请自行添加

<?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.study.springboot</groupId>
<artifactId>mybatis</artifactId>
<version>1.0</version>
<packaging>war</packaging> <name>demo</name>
<description>springboot+mybatis+jpa</description> <parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>1.5.9.RELEASE</version>
<relativePath/>
</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-data-jpa</artifactId>
</dependency>
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>1.3.1</version>
</dependency>
<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>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-tomcat</artifactId>

</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency> 
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid</artifactId>
<version>1.1.5</version>
</dependency> </dependencies> <build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin> 
<plugin>
<groupId>org.mybatis.generator</groupId>
<artifactId>mybatis-generator-maven-plugin</artifactId>
<version>1.3.5</version>
<executions>
<execution>
<id>Generate MyBatis Artifacts</id>
<goals>
<goal>generate</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build></project>

1.1.3 配置generatorConfiguration

generatorConfig.xml放在resource文件夹下

常用配置已经注释了，请自行查看

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd"><generatorConfiguration> 
 
<classPathEntry
location="C:\Users\Semi\.m2\repository\mysql\mysql-connector-java\5.1.38\mysql-connector-java-5.1.38.jar"/> 
<context id="MyBatis" targetRuntime="MyBatis3"> 
<property name="autoDelimitKeywords" value="false"/>

<property name="javaFileEncoding" value="UTF-8"/>

<property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter"/>

<property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter"/> 
<commentGenerator>
<property name="suppressAllComments" value="true"/>
<property name="suppressDate" value="true"/>
</commentGenerator> 
<jdbcConnection driverClass="com.mysql.jdbc.Driver"
connectionURL="jdbc:mysql://localhost:3306/test"
userId="root"
password="123456"/> 
<javaTypeResolver>

<property name="forceBigDecimals" value="false"/>
</javaTypeResolver> 
<javaModelGenerator targetPackage="com.study.springboot.mybatis.model"
targetProject="E:\WorkSpace\study\springboot\mybatis\src\main\java"> 
 
<property name="enableSubPackages" value="false"/> 
 
 
<property name="trimStrings" value="true"/>
</javaModelGenerator> 
<sqlMapGenerator targetPackage="mapper"
targetProject="E:\WorkSpace\study\springboot\mybatis\src\main\resources">

<property name="enableSubPackages" value="false"/>
</sqlMapGenerator> 
<javaClientGenerator type="XMLMAPPER" targetPackage="com.study.springboot.mybatis.mapper"
targetProject="E:\WorkSpace\study\springboot\mybatis\src\main\java">

<property name="enableSubPackages" value="false"/> 
</javaClientGenerator> <!--
选择一个table来生成相关文件,可以有一个或多个table,必须要有table元素
选择的table会生成一下文件:
1. SQL map文件
2. 生成一个主键类
3. 除了BLOB和主键的其他字段的类
4. 包含BLOB的类
5. 一个用户生成动态查询的条件类(selectByExample, deleteByExample)可选
6. Mapper接口(可选) tableName(必要):要生成对象的表名,%表示通配,即为该数据库下的所有表生成xml文件
注意:大小写敏感问题.正常情况下,MBG会自动的去识别数据库标识符的大小写敏感度,在一般情况下
MBG会根据设置的schema,catalog或tablename去查询数据表,按照下面的流程:
1. 如果schema,catalog或tablename中有空格,那么设置的是什么格式,就精确的使用指定的大小写格式去查询
2. 否则,如果数据库的标识符使用大写的,那么MBG自动把表名变成大写再查找
3. 否则,如果数据库的标识符使用小写的,那么MBG自动把表名变成小写再查找
4. 否则,使用指定的大小写格式查询
另外,如果在创建表的时候,使用的""把数据库对象规定大小写,就算数据库标识符是使用的大写,在这种情况下也会使用给定的大小写来创建表名
这个时候,请设置delimitIdentifiers="true"即可保留大小写格式

可选:

1. schema:数据库的schema
2. catalog:数据库的catalog
3. alias:为数据表设置的别名,如果设置了alias,那么生成的所有的SELECT SQL语句中,列名会变成:alias_actualColumnName
4. domainObjectName:生成的domain类的名字,如果不设置,直接使用表名作为domain类的名字;可以设置为somepck.domainName,那么会自动把domainName类再放到somepck包里面
5. enableInsert(默认true):指定是否生成insert语句
6. enableSelectByPrimaryKey(默认true):指定是否生成按照主键查询对象的语句(就是getById或get)
7. enableSelectByExample(默认true):MyBatis3Simple为false,指定是否生成动态查询语句
8. enableUpdateByPrimaryKey(默认true):指定是否生成按照主键修改对象的语句(即update)
9. enableDeleteByPrimaryKey(默认true):指定是否生成按照主键删除对象的语句(即delete)
10. enableDeleteByExample(默认true):MyBatis3Simple为false,指定是否生成动态删除语句
11. enableCountByExample(默认true):MyBatis3Simple为false,指定是否生成动态查询总条数语句(用于分页的总条数查询)
12. enableUpdateByExample(默认true)MyBatis3Simple为false,指定是否生成动态修改语句(只修改对象中不为空的属性)
13. modelType:参考context元素的defaultModelType,相当于覆盖
14. delimitIdentifiers:参考tableName的解释,注意,默认的delimitIdentifiers是双引号,如果类似MYSQL这样的数据库,使用的是`(反引号,那么还需要设置context的beginningDelimiter和endingDelimiter属性)
15. delimitAllColumns:设置是否所有生成的SQL中的列名都使用标识符引起来.默认为false,delimitIdentifiers参考context的属性

注意,table里面很多参数都是对javaModelGenerator,context等元素的默认属性的一个复写 -->

<table tableName="%"
enableCountByExample="false"
enableUpdateByExample="false"
enableDeleteByExample="false"
enableSelectByExample="false"
selectByExampleQueryId="false">

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

</table>
</context>
</generatorConfiguration>

1.1.4 生成xxxMapper.java接口以及xxxMapper.xml文件

20180126111603.png

注意，如果存放xxxMapper.java和xxxMapper.xml文件的包不存在会报错

1.1.5 修改自动生成的实体类

对于model包下的实体类需要添加基于JPA的注解,否则JPA接口无法引用

例如对于User.java实体类需要进行如下修改

package com.study.springboot.mybatis.model;import javax.persistence.*;@Entity
@Table(name = "user")
public class User { @Id
@GeneratedValue
@Column(name = "id")
private Integer id; @Column(name = "user_name")
private String userName; @Column(name = "passwd")
private String passwd; @Column(name = "nick_name")
private String nickName; @Column(name = "telephone")
private String telephone; @Column(name = "email")
private String email; @Column(name = "authority")
private Integer authority; @Column(name = "department")
private String department; @Column(name = "create_at")
private String createAt; @Column(name = "update_at")
private String updateAt; public Integer getId() {
return id;
} public void setId(Integer id) {
this.id = id;
} public String getUserName() {
return userName;
} public void setUserName(String userName) {
this.userName = userName == null ? null : userName.trim();
} public String getPasswd() {
return passwd;
} public void setPasswd(String passwd) {
this.passwd = passwd == null ? null : passwd.trim();
} public String getNickName() {
return nickName;
} public void setNickName(String nickName) {
this.nickName = nickName == null ? null : nickName.trim();
} public String getTelephone() {
return telephone;
} public void setTelephone(String telephone) {
this.telephone = telephone == null ? null : telephone.trim();
} public String getEmail() {
return email;
} public void setEmail(String email) {
this.email = email == null ? null : email.trim();
} public Integer getAuthority() {
return authority;
} public void setAuthority(Integer authority) {
this.authority = authority;
} public String getDepartment() {
return department;
} public void setDepartment(String department) {
this.department = department == null ? null : department.trim();
} public String getCreateAt() {
return createAt;
} public void setCreateAt(String createAt) {
this.createAt = createAt == null ? null : createAt.trim();
} public String getUpdateAt() {
return updateAt;
} public void setUpdateAt(String updateAt) {
this.updateAt = updateAt == null ? null : updateAt.trim();
}
}

1.1.6 添加xxxJPA接口,例如UserJPA.java

import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.jpa.repository.JpaSpecificationExecutor;import java.io.Serializable;public interface UserJPA extends
Serializable,
JpaRepository<User, Integer>,
JpaSpecificationExecutor<User> {
}

1.1.7 测试

测试之前需要配置application.yml(你的有能是application.properties,改一下后缀名即可,我比较喜欢.yml文件的简洁)

spring:
datasource:
type: com.alibaba.druid.pool.DruidDataSource
url: jdbc:mysql://localhost:3306/test?useUnicode=true&characterEncoding=utf8&characterSetResults=utf8
driver-class-name: com.mysql.jdbc.Driver
username: root
password: 123456
mybatis:
# 重要配置
type-aliases-package: com.study.springboot.mybatis.model
mapper-locations: classpath:mapper/*.xml

对于每一个xxxMapper.java接口，需要使用@Component注解

自动生成的xxxMapper.java接口是不带@Component注解的

@Component
public interface UserMapper {
int deleteByPrimaryKey(Integer id); int insert(User record); int insertSelective(User record); User selectByPrimaryKey(Integer id); int updateByPrimaryKeySelective(User record); int updateByPrimaryKey(User record);
}

在入口类中需要添加@MapperScan("com.study.springboot.mybatis.mapper")注解

@SpringBootApplication
@MapperScan("com.study.springboot.mybatis.mapper")
public class MybatisApplication { public static void main(String[] args) {
SpringApplication.run(MybatisApplication.class, args);
}
}

打开测试类，为测试类添加@MapperScan("com.study.springboot.mybatis.mapper")注解

@RunWith(SpringRunner.class)
@SpringBootTest
@MapperScan("com.study.springboot.mybatis.mapper")
public class MybatisApplicationTests { @Autowired
private UserMapper userMapper; @Autowired
private UserJPA userJPA; @Test
public void contextLoads() {
System.out.println(userMapper.selectByPrimaryKey(11).getUserName());
System.out.println(userJPA.findOne(11).getUserName());
} }