运维开发网

SpringBoot 快速整合Mybatis(去XML化+注解进阶)

运维开发网 https://www.qedev.com 2020-02-20 19:24 出处:51CTO 作者:JAVA少女
一. 基础注解MyBatis 主要提供了以下CRUD注解:@Select@Insert@Update@Delete增删改查占据了绝大部分的业务操作,掌握这些基础注解的使用还是很有必要的,例如下面这段代码无需XML即可完成数据查询:@Mapperpublic interface UserMapper {   @Select("se

一. 基础注解

MyBatis 主要提供了以下CRUD注解:

  • @Select

  • @Insert

  • @Update

  • @Delete

增删改查占据了绝大部分的业务操作,掌握这些基础注解的使用还是很有必要的,例如下面这段代码无需XML即可完成数据查询:

@Mapperpublic interface UserMapper {   @Select("select * from t_user")   List<User> list();}

使用过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")   List<User> list();

查询结果如下,:

[ {   "userId": "1",   "username": "admin",   "password": "admin",   "mobileNum": "15011791234" }, {   "userId": "2",   "username": "roots",   "password": "roots",   "mobileNum": "18812342017" }]

为了解决对象属性和字段驼峰不一致的问题,我们可以使用映射注解@Results来指定映射关系。

为了方便演示和免除手工编写映射关系的烦恼,这里提供了一个快速生成映射结果集的方法,具体内容如下:

/**    * 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方法执行效果如下:然后我们将控制台这段打印信息复制到接口方法上即可。

SpringBoot 快速整合Mybatis(去XML化+注解进阶)

三. 高级注解

MyBatis-3 主要提供了以下CRUD的高级注解:

  • @SelectProvider

  • @InsertProvider

  • @UpdateProvider

  • @DeleteProvider

见名知意,这些高级注解主要用于动态SQL,这里以@SelectProvider 为例,主要包含两个注解属性,其中type表示工具类,method 表示工具类的某个方法,用于返回具体的SQL。

@Mapperpublic interface UserMapper {   @SelectProvider(type = UserSqlProvider.class, method = "list222")   List<User> list2();}

工具类代码如下:

public class UserSqlProvider {   public String list222() {       return "select * from t_user ;   }

四. 详细教程

对上述注解有所了解之后,我们以具体项目案例来进一步巩固这些注解的实际使用。

1. 引入依赖

为了方便演示,首选搭建Web环境,另外数据库选择Mysql 5.5+。

<dependencies>       <dependency> <!--添加Web依赖 -->           <groupId>org.springframework.boot</groupId>           <artifactId>spring-boot-starter-web</artifactId>       </dependency>       <dependency> <!--添加Mybatis依赖 -->           <groupId>org.mybatis.spring.boot</groupId>           <artifactId>mybatis-spring-boot-starter</artifactId>           <version>1.3.1</version>       </dependency>       <dependency><!--添加MySQL驱动依赖 -->           <groupId>mysql</groupId>           <artifactId>mysql-connector-java</artifactId>           <scope>runtime</scope>       </dependency>       <dependency><!--添加Test依赖 -->           <groupId>org.springframework.boot</groupId>           <artifactId>spring-boot-starter-test</artifactId>           <scope>test</scope>       </dependency>   </dependencies>

2. 添加配置

这里主要是添加数据源,配置驼峰映射和开启SQL日志的控制台打印。在项目的资源目录中,添加 application.yml 配置如下:

  1. spring:

  2. datasource:

  3.   #连接MySQL

  4.   url: jdbc:mysql://localhost:3306/socks?useSSL=false

  5.   username: root

  6.   password: root

  7.   driver-class-name: com.mysql.jdbc.Driver

  8. mybatis:

  9. configuration:

  10.  #配置项:开启下划线到驼峰的自动转换. 作用:将数据库字段根据驼峰规则自动注入到对象属性。

  11.  map-underscore-to-camel-case: true

  12. logging:

  13. level:

  14.  #打印SQL信息

  15.  com.hehe.mapper: debug

3. 编写数据层代码

这里以我们熟悉的用户信息为例,编写UserMapper接口和本案例使用的UserSqlProvider。

3.1 UserMapper

添加UserMapper接口用于数据查询:

  1. package com.hehe.mapper;

  2. @Mapper

  3. public interface UserMapper {

  4.   /**

  5.    * 方式1:使用注解编写SQL。

  6.    */

  7.   @Select("select * from t_user")

  8.   List<User> list();

  9.   /**

  10.    * 方式2:使用注解指定某个工具类的方法来动态编写SQL.

  11.    */

  12.   @SelectProvider(type = UserSqlProvider.class, method = "listByUsername")

  13.   List<User> listByUsername(String username);

  14.   /**

  15.    * 延伸:上述两种方式都可以附加@Results注解来指定结果集的映射关系.

  16.    *

  17.    * PS:如果符合下划线转驼峰的匹配项可以直接省略不写。

  18.    */

  19.   @Results({

  20.           @Result(property = "userId", column = "USER_ID"),

  21.           @Result(property = "username", column = "USERNAME"),

  22.           @Result(property = "password", column = "PASSWORD"),

  23.           @Result(property = "mobileNum", column = "PHONE_NUM")

  24.   })

  25.   @Select("select * from t_user")

  26.   List<User> listSample();

  27.   /**

  28.    * 延伸:无论什么方式,如果涉及多个参数,则必须加上@Param注解,否则无法使用EL表达式获取参数。

  29.    */

  30.   @Select("select * from t_user where username like #{username} and password like #{password}")

  31.   User get(@Param("username") String username, @Param("password") String password);

  32.   @SelectProvider(type = UserSqlProvider.class, method = "getBadUser")

  33.   User getBadUser(@Param("username") String username, @Param("password") String password);

  34. }

3.2 UserSqlProvider

添加UserSqlProvider,用于生成SQL的工具类 。

  1. /**

  2. * 主要用途:根据复杂的业务需求来动态生成SQL.

  3. * <p>

  4. * 目标:使用Java工具类来替代传统的XML文件.(例如:UserSqlProvider.java <-- UserMapper.xml)

  5. */

  6. public class UserSqlProvider {

  7.   /**

  8.    * 方式1:在工具类的方法里,可以自己手工编写SQL。

  9.    */

  10.   public String listByUsername(String username) {

  11.       return "select * from t_user where username =#{username}";

  12.   }

  13.   /**

  14.    * 方式2:也可以根据官方提供的API来编写动态SQL。

  15.    */

  16.   public String getBadUser(@Param("username") String username, @Param("password") String password) {

  17.       return new SQL() {{

  18.           SELECT("*");

  19.           FROM("t_user");

  20.           if (username != null && password != null) {

  21.               WHERE("username like #{username} and password like #{password}");

  22.           } else {

  23.               WHERE("1=2");

  24.           }

  25.       }}.toString();

  26.   }

  27. }

3.3 实体类User

添加实体类User

public class User {   private String userId;   private String username;   private String password;   private String mobileNum;   //Getters & Setters}

3.4 添加数据库记录

打开Navicat 查询窗口,然后只需下面这段脚本。

  1. USE `SOCKS`;

  2. DROP TABLE IF EXISTS `t_user`;

  3. CREATE TABLE `t_user` (

  4. `USER_ID` varchar(50) ,

  5. `USERNAME` varchar(50) ,

  6. `PASSWORD` varchar(50) ,

  7.   `PHONE_NUM` varchar(15)

  8. ) ;

  9. INSERT INTO `t_user` VALUES ('1', 'admin', 'admin','15011791234');

  10. INSERT INTO `t_user` VALUES ('2', 'roots', 'roots','18812342017');

4. 编写控制层代码

  1. package com.hehe.controller;

  2. @RestController

  3. @RequestMapping("/user/*")

  4. public class UserController {

  5.   @SuppressWarnings("all")

  6.   @Autowired

  7.   UserMapper userMapper;

  8.   @GetMapping("list")

  9.   public List<User> list() {

  10.       return userMapper.list();

  11.   }

  12.   @GetMapping("list/{username}")

  13.   public List<User> listByUsername(@PathVariable("username") String username) {

  14.       return userMapper.listByUsername(username);

  15.   }

  16.   @GetMapping("get/{username}/{password}")

  17.   public User get(@PathVariable("username") String username, @PathVariable("password") String password) {

  18.       return userMapper.get(username, password);

  19.   }

  20.   @GetMapping("get/bad/{username}/{password}")

  21.   public User getBadUser(@PathVariable("username") String username, @PathVariable("password") String password) {

  22.       return userMapper.getBadUser(username, password);

  23.   }

  24. }

5. 启动和测试

启动工程后,访问 http://localhost:8080/user/list 可以查看用户列表如下:

SpringBoot 快速整合Mybatis(去XML化+注解进阶)

访问 http://localhost:8080/user/list/admin 可以查询用户名为admin的信息:

SpringBoot 快速整合Mybatis(去XML化+注解进阶)

五. 源码和文档

源码地址:

https://link.jianshu.com/?t=https://github.com/yizhiwazi/springboot-socks

0

精彩评论

暂无评论...
验证码 换一张
取 消