详解SpringBoot快速整合Mybatis(去XML化+注解进阶)
序言:使用MyBatis3提供的注解可以逐步取代XML,例如使用@Select注解直接编写SQL完成数据查询,使用@SelectProvider高级注解还可以编写动态SQL,以应对复杂的业务需求。
为宜章等地区用户提供了全套网页设计制作服务,及宜章网站建设行业解决方案。主营业务为做网站、成都网站制作、宜章网站设计,以传统方式定制建设网站,并提供域名空间备案等一条龙服务,秉承以专业、用心的态度为用户提供真诚的服务。我们深信只要达到每一位用户的要求,就会得到认可,从而选择与我们长期合作。这样,我们也可以走得更远!
一. 基础注解
MyBatis 主要提供了以下CRUD注解:
- @Select
- @Insert
- @Update
- @Delete
增删改查占据了绝大部分的业务操作,掌握这些基础注解的使用是很必要的。例如下面这段代码无需XML即可完成数据查询:
@Mapper public interface UserMapper { @Select("select * from t_user") Listlist(); }
使用过Hibernate的同学可能会好奇,这里为什么没有配置映射关系也能完成属性注入?在传统项目使用过Mybatis的童鞋可能很会就能反应过来,是因为在配置文件中开启了全局驼峰映射,SpringBoot中同样能够做到,并且更为简单快捷。
虽然开启了全局驼峰映射,但你可能还会质疑,如果不符合下划线转驼峰规则的字段,拿查询回来的实体对象属性将获取为null,比如上述User对象属性mobileNum和对应的数据库字段phoneNum,则查询结果为:
[ { "userId": "1", "username": "admin", "password": "admin", "mobileNum": null }, { "userId": "2", "username": "roots", "password": "roots", "mobileNum": null } ]
为了解决对象属性和字段驼峰不一致的问题,我们可以使用映射注解@Results来指定映射关系。
二. 映射注解
Mybatis主要提供这些映射注解:
- @Results 用于填写结果集的多个字段的映射关系.
- @Result 用于填写结果集的单个字段的映射关系.
- @ResultMap 根据ID关联XML里面
.
例如上面的list方法,我们可以在查询SQL的基础上,指定返回的结果集的映射关系,其中property表示实体对象的属性名,column表示对应的数据库字段名。
@Results({ @Result(property = "userId", column = "USER_ID"), @Result(property = "username", column = "USERNAME"), @Result(property = "password", column = "PASSWORD"), @Result(property = "mobileNum", column = "PHONE_NUM") }) @Select("select * from t_user") Listlist();
查询结果如下,:
[ { "userId": "1", "username": "admin", "password": "admin", "mobileNum": "15011791234" }, { "userId": "2", "username": "roots", "password": "roots", "mobileNum": "18812342017" } ]
为了方便演示和免除手工编写映射关系的烦恼,这里提供了一个快速生成映射结果集的方法,具体内容如下:
/** * 1.用于获取结果集的映射关系 */ public static String getResultsStr(Class origin) { StringBuilder stringBuilder = new StringBuilder(); stringBuilder.append("@Results({\n"); for (Field field : origin.getDeclaredFields()) { String property = field.getName(); //映射关系:对象属性(驼峰)->数据库字段(下划线) String column = new PropertyNamingStrategy.SnakeCaseStrategy().translate(field.getName()).toUpperCase(); stringBuilder.append(String.format("@Result(property = \"%s\", column = \"%s\"),\n", property, column)); } stringBuilder.append("})"); return stringBuilder.toString(); }
在当前Main方法执行效果如下:然后我们将控制台这段打印信息复制到接口方法上即可。
三. 高级注解
MyBatis-3 主要提供了以下CRUD的高级注解:
- @SelectProvider
- @InsertProvider
- @UpdateProvider
- @DeleteProvider
见名知意,这些高级注解主要用于动态SQL,这里以@SelectProvider 为例,主要包含两个注解属性,其中type表示工具类,method 表示工具类的某个方法,用于返回具体的SQL。
@Mapper public interface UserMapper { @SelectProvider(type = UserSqlProvider.class, method = "list222") Listlist2(); } 工具类代码如下: public class UserSqlProvider { public String list222() { return "select * from t_user ; }
四. 详细教程
对上述注解有所了解之后,我们以具体项目案例来进一步巩固这些注解的实际使用。
具体步骤
1. 引入依赖
为了方便演示,首选搭建Web环境,另外数据库选择MySQL 5.5+。
org.springframework.boot spring-boot-starter-web org.mybatis.spring.boot mybatis-spring-boot-starter 1.3.1 mysql mysql-connector-java runtime org.springframework.boot spring-boot-starter-test test
2. 添加配置
这里主要是添加数据源,配置驼峰映射和开启SQL日志的控制台打印。在项目的资源目录中,添加 application.yml 配置如下:
spring: datasource: #连接MySQL url: jdbc:mysql://localhost:3306/socks?useSSL=false username: root password: root driver-class-name: com.mysql.jdbc.Driver mybatis: configuration: #配置项:开启下划线到驼峰的自动转换. 作用:将数据库字段根据驼峰规则自动注入到对象属性。 map-underscore-to-camel-case: true logging: level: #打印SQL信息 com.hehe.mapper: debug
3. 编写数据层代码
这里以我们熟悉的用户信息为例,编写UserMapper接口和本案例使用的UserSqlProvider。
3.1 UserMapper
添加UserMapper接口用于数据查询:
package com.hehe.mapper; @Mapper public interface UserMapper { /** * 方式1:使用注解编写SQL。 */ @Select("select * from t_user") Listlist(); /** * 方式2:使用注解指定某个工具类的方法来动态编写SQL. */ @SelectProvider(type = UserSqlProvider.class, method = "listByUsername") List listByUsername(String username); /** * 延伸:上述两种方式都可以附加@Results注解来指定结果集的映射关系. * * PS:如果符合下划线转驼峰的匹配项可以直接省略不写。 */ @Results({ @Result(property = "userId", column = "USER_ID"), @Result(property = "username", column = "USERNAME"), @Result(property = "password", column = "PASSWORD"), @Result(property = "mobileNum", column = "PHONE_NUM") }) @Select("select * from t_user") List listSample(); /** * 延伸:无论什么方式,如果涉及多个参数,则必须加上@Param注解,否则无法使用EL表达式获取参数。 */ @Select("select * from t_user where username like #{username} and password like #{password}") User get(@Param("username") String username, @Param("password") String password); @SelectProvider(type = UserSqlProvider.class, method = "getBadUser") User getBadUser(@Param("username") String username, @Param("password") String password); }
3.2 UserSqlProvider
添加UserSqlProvider,用于生成SQL的工具类 。
package com.hehe.mapper; /** * 主要用途:根据复杂的业务需求来动态生成SQL. ** 目标:使用Java工具类来替代传统的XML文件.(例如:UserSqlProvider.java <-- UserMapper.xml) */ public class UserSqlProvider { /** * 方式1:在工具类的方法里,可以自己手工编写SQL。 */ public String listByUsername(String username) { return "select * from t_user where username =#{username}"; } /** * 方式2:也可以根据官方提供的API来编写动态SQL。 */ public String getBadUser(@Param("username") String username, @Param("password") String password) { return new SQL() {{ SELECT("*"); FROM("t_user"); if (username != null && password != null) { WHERE("username like #{username} and password like #{password}"); } else { WHERE("1=2"); } }}.toString(); } }
3.3 实体类User
添加实体类User
public class User { private String userId; private String username; private String password; private String mobileNum; //Getters & Setters }
3.4 添加数据库记录
打开Navicat 查询窗口,然后只需下面这段脚本。
USE `SOCKS`; DROP TABLE IF EXISTS `t_user`; CREATE TABLE `t_user` ( `USER_ID` varchar(50) , `USERNAME` varchar(50) , `PASSWORD` varchar(50) , `PHONE_NUM` varchar(15) ) ; INSERT INTO `t_user` VALUES ('1', 'admin', 'admin','15011791234'); INSERT INTO `t_user` VALUES ('2', 'roots', 'roots','18812342017');
4. 编写控制层代码
package com.hehe.controller; @RestController @RequestMapping("/user/*") public class UserController { @SuppressWarnings("all") @Autowired UserMapper userMapper; @GetMapping("list") public Listlist() { return userMapper.list(); } @GetMapping("list/{username}") public List listByUsername(@PathVariable("username") String username) { return userMapper.listByUsername(username); } @GetMapping("get/{username}/{password}") public User get(@PathVariable("username") String username, @PathVariable("password") String password) { return userMapper.get(username, password); } @GetMapping("get/bad/{username}/{password}") public User getBadUser(@PathVariable("username") String username, @PathVariable("password") String password) { return userMapper.getBadUser(username, password); } }
5. 启动和测试
启动工程后,访问 http://localhost:8080/user/list 可以查看用户列表如下:
访问 http://localhost:8080/user/list/admin 可以查询用户名为admin的信息:
五. 文档
官方文档:Mybatis3-中文手册
关于MyBatis注解的使用:
优点:无需XML,使用轻量级注解就可以编写SQL并返回查询结果,功能强大且方便。
缺点:MyBatis使用注解最大的缺点是无法实现实体属性和数据库字段的映射关系,如果不满足驼峰的话,每个查询都要使用@Results,会造成一定代码冗余,官方承认把这个重大缺陷甩给了Java注解的限制,为了解决这个问题,接下来我们学习如何在项目中快速引入通用Mapper,让Mapper接口通过泛型继承就能获取基于单个对象的增删改查!!
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持创新互联。
网页题目:详解SpringBoot快速整合Mybatis(去XML化+注解进阶)
URL地址:http://pwwzsj.com/article/jchseo.html