一、背景
最近想复习一下spring boot和mybatis的知识,就搞了一个spring boot项目,也是通过查找网上的资料做的,但是发现大部分整合都是spring boot 1.5版本的,我使用的是2.5.4版本,就出现了许多错误。现在就来记录一下这次实现吧,同时也会实现mybatis自动生成mapper文件。希望对大家有帮助,可以通过git下载进行参考,地址:GitHub - xujiankang6/spring-boot-research
二、实现
1、通过idea创建一个spring boot项目。
2、添加下面的依赖。
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-test</artifactId> <scope>test</scope> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-configuration-processor</artifactId> <optional>true</optional> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-devtools</artifactId> <optional>true</optional> </dependency> <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>2.0.1</version> </dependency> <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot</artifactId> <version>2.0.1</version> </dependency> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>5.1.35</version> </dependency> <!--mybatis pagerhelper分页--> <dependency> <groupId>com.github.pagehelper</groupId> <artifactId>pagehelper-spring-boot-starter</artifactId> <version>1.2.5</version> </dependency> <dependency> <groupId>com.alibaba</groupId> <artifactId>druid-spring-boot-starter</artifactId> <version>1.2.5</version> </dependency>
3、同时pom文件里面</plugins>标签下面添加自动生成mybatis插件。
(1)后面需要在resources目录下新建这个目录和文件结构。/generator/generatorConfig.xml
<!-- mybatis generator 自动生成代码插件 --> <plugin> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-maven-plugin</artifactId> <version>1.3.2</version> <configuration> <configurationFile>${basedir}/src/main/resources/generator/generatorConfig.xml</configurationFile> <overwrite>true</overwrite> <verbose>true</verbose> </configuration> </plugin>
4、将application.properties删除,新建application.yml文件,配置端口,mysql数据库,mybatis等。
(1)修改自己的本地数据库名,账户密码。
(2)修改自己实体类要存放的路径。
server: port: 8080 spring: datasource: name: test url: jdbc:mysql://127.0.0.1:3306/test username: root password: 123456 # 使用druid数据源 type: com.alibaba.druid.pool.DruidDataSource driver-class-name: com.mysql.jdbc.Driver filters: stat maxActive: 20 initialSize: 1 maxWait: 60000 minIdle: 1 timeBetweenEvictionRunsMillis: 60000 minEvictableIdleTimeMillis: 300000 validationQuery: select 'x' testWhileIdle: true testOnBorrow: false testOnReturn: false poolPreparedStatements: true maxOpenPreparedStatements: 20 ## 该配置节点为独立的节点,有很多同学容易将这个配置放在spring的节点下,导致配置无法被识别 mybatis: mapper-locations: classpath:mapping/*.xml #注意:一定要对应mapper映射xml文件的所在路径 type-aliases-package: com.example.demo.model # 注意:对应实体类的路径
5、在启动类同级目录和resources目录下新建一些文件目录。
(1)在启动类同级新建controller,mapper,model,service四个目录。
(2)在 resources目录下新建一个mapping目录,用来存放后面自动生成的mapper.xml文件。
(3)新建一个generator目录,同时新建一个generatorConfig.xml文件,跟第三步的配置的自动生成mybatis插件目录一致。文件目录如下,需要修改成自己需要自动创建的表。
<?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="D:\spring20210828\jar\mysql-connector-java-5.1.25.jar"/> <context id="DB2Tables" targetRuntime="MyBatis3"> <commentGenerator> <property name="suppressDate" value="true"/> <!-- 是否去除自动生成的注释 true:是 : false:否 --> <property name="suppressAllComments" value="true"/> </commentGenerator> <!--数据库链接URL,用户名、密码 --> <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://127.0.0.1/test" userId="root" password="123456"> </jdbcConnection> <javaTypeResolver> <property name="forceBigDecimals" value="false"/> </javaTypeResolver> <!-- 生成模型的包名和位置--> <javaModelGenerator targetPackage="com.example.demo.model" targetProject="src/main/java"> <property name="enableSubPackages" value="true"/> <property name="trimStrings" value="true"/> </javaModelGenerator> <!-- 生成映射文件的包名和位置--> <sqlMapGenerator targetPackage="mapping" targetProject="src/main/resources"> <property name="enableSubPackages" value="true"/> </sqlMapGenerator> <!-- 生成DAO的包名和位置--> <javaClientGenerator type="XMLMAPPER" targetPackage="com.example.demo.mapper" targetProject="src/main/java"> <property name="enableSubPackages" value="true"/> </javaClientGenerator> <!-- 要生成的表 tableName是数据库中的表名或视图名 domainObjectName是实体类名--> <table tableName="user" domainObjectName="User" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false"></table> </context> </generatorConfiguration>
6、点击Edit Configurations,新建一个maven项。
(1)命名为generator。
(2)Command line配置为下面的内容。
mybatis-generator:generate -e
(1)注意,只执行一次即可,多次执行generator,UserMapper文件里面会生成重复的方法,启动项目可能会报错。
8、新建一个service接口
(1)这个接口里面的方法是复制的自动生成的UserMapper接口里面的方法。
public interface UserService { int deleteByPrimaryKey(Integer uid); int insert(User record); int insertSelective(User record); User selectByPrimaryKey(Integer uid); int updateByPrimaryKeySelective(User record); int updateByPrimaryKey(User record); }
9、新建service实现类
(1)引入的userMapper类,可能会爆红警告,不过不影响启动。
package com.example.demo.service.impl; import com.example.demo.mapper.UserMapper; import com.example.demo.model.User; import com.example.demo.service.UserService; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service; /** * UserServiceImpl * * @author jiankang.xu * @date 2021/8/29 */ @Service public class UserServiceImpl implements UserService { @Autowired private UserMapper userMapper; @Override public int deleteByPrimaryKey(Integer uid) { return userMapper.deleteByPrimaryKey(uid); } @Override public int insert(User record) { return userMapper.insert(record); } @Override public int insertSelective(User record) { return userMapper.insertSelective(record); } @Override public User selectByPrimaryKey(Integer uid) { return userMapper.selectByPrimaryKey(uid); } @Override public int updateByPrimaryKeySelective(User record) { return userMapper.updateByPrimaryKeySelective(record); } @Override public int updateByPrimaryKey(User record) { return userMapper.updateByPrimaryKey(record); } }
10、新建一个controller类
package com.example.demo.controller; import com.example.demo.model.User; import com.example.demo.service.UserService; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.ResponseBody; /** * UserMapperController * * @author jiankang.xu * @date 2021/8/29 */ @Controller @RequestMapping("/mapper") public class UserMapperController { @Autowired private UserService userService; @RequestMapping("/getuser/{uid}") @ResponseBody public User getUser(@PathVariable String uid){ return userService.selectByPrimaryKey(Integer.valueOf(uid)); } }
11、启动spring boot项目,访问这个端口,就可以查询到数据库里的数据了。
三、问题
1、NoClassDefFoundError: org/springframework/boot/bind/RelaxedDataBinder
(1)这个错误是alibaba的druid数据库连接池的版本过低,原来我的版本是低于1.2.5的,spring boot 1x版本使用不会报错,我的版本是2x以上,所以改为1.2.5就不会报错了。
<!-- alibaba的druid数据库连接池 --> <dependency> <groupId>com.alibaba</groupId> <artifactId>druid-spring-boot-starter</artifactId> <version>1.2.5</version> </dependency>
2、Error creating bean with name 'com.github.pagehelper.autoconfigure.PageHelperAutoConfiguration'
(1)这个错误是mybatis pagerhelper分页依赖版本太低,不支持spring boot 2x版本,改为下面的就好了。
<!--mybatis pagerhelper分页--> <dependency> <groupId>com.github.pagehelper</groupId> <artifactId>pagehelper-spring-boot-starter</artifactId> <version>1.2.5</version> </dependency>
3、Error creating bean with name 'userMapper' defined in file
(1)这个在引入userMapper时,需要添加@Autowired。
四、总结
以上就是关于spring boot 2以上版本整合mybatis的全部内容,希望能够帮到大家,这篇文章可以收获学会spring boot整合mybatis,自动生成mapper文件等等,觉得不错的话,欢迎微信搜索关注java基础笔记,后面会不断更新相关知识,大家一起进步。