序言：使用MyBatis3提供的注解可以逐步取代XML，例如使用@Select注解直接编写SQL完成数据查询，使用@SelectProvider高级注解还可以编写动态SQL，以应对复杂的业务需求。

一. 基础注解

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

@Select

@Insert

@Update

@Delete

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

@Mapper

public interface UserMapper {

@Select("select * from t_user")

List 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 list();

查询结果如下，：

[

{

"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")

List list2();

}

工具类代码如下：

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")

List list();

/**

* 方式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

*/

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 List list() {

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的信息：

五. 文档

关于MyBatis注解的使用：

优点：无需XML，使用轻量级注解就可以编写SQL并返回查询结果，功能强大且方便。

缺点：MyBatis使用注解最大的缺点是无法实现实体属性和数据库字段的映射关系，如果不满足驼峰的话，每个查询都要使用@Results，会造成一定代码冗余，官方承认把这个重大缺陷甩给了Java注解的限制，为了解决这个问题，接下来我们学习如何在项目中快速引入通用Mapper，让Mapper接口通过泛型继承就能获取基于单个对象的增删改查！！

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持脚本之家。

java xml快捷注释_详解SpringBoot 快速整合Mybatis（去XML化+注解进阶）相关推荐

  1. java h5模板引擎_详解SpringBoot+Thymeleaf 基于HTML5的现代模板引擎

    序言: Thymeleaf 是Java服务端的模板引擎,与传统的JSP不同,前者可以使用浏览器直接打开,因为可以忽略掉拓展属性,相当于打开原生页面,给前端人员也带来一定的便利.如果你已经厌倦了JSP+ ...

  2. java 配置文件的路径_详解java配置文件的路径问题

    详解java配置文件的路径问题 详解java配置文件的路径问题 各种语言都有自己所支持的配置文件,配置文件中有很多变量是经常改变的.不将程序中的各种变量写死,这样能更方便地脱离程序本身去修改相关变量设 ...

  3. java新建一个女朋友_详解java创建一个女朋友类（对象啥的new一个就是）==建造者模式，一键重写...

    创建一个女朋友,她有很多的属性,比如:性别,年龄,身高,体重,类型等等,虽然每个女朋友都有这些属性,但是每个人找女朋友的要求都是不一样的,有的人喜欢男的,有的人喜欢女的,有的喜欢胖的,不同的人可以根据 ...

  4. java中batch基础_详解Spring batch 入门学习教程(附源码)

    详解Spring batch 入门学习教程(附源码) 发布时间:2020-09-08 00:28:40 来源:脚本之家 阅读:99 作者:achuo Spring batch 是一个开源的批处理框架. ...

  5. java使用集合存储过程_详解java调用存储过程并封装成map

    详解java调用存储过程并封装成map 发布于 2020-5-1| 复制链接 摘记: 详解java调用存储过程并封装成map           本文代码中注释写的比较清楚不在单独说明,希望能帮助到大 ...

  6. java生成pdf方法_详解Java生成PDF文档方法|chu

    最近项目需要实现PDF下载的功能,由于没有这方面的经验,从网上花了很长时间才找到相关的资料.整理之后,发现有如下几个框架可以实现这个功能. 1. 开源框架支持iText,生成PDF文档,还支持将XML ...

  7. java string设置编码_详解Java中String类型与默认字符编码

    为什么写这个 至于为什么要写这个,主要是一句mmp一定要讲,绕了一上午,晕死 Java程序中的中文乱码问题一直是一个困扰程序员的难题,自己也不例外,早在做项目时就遇到过很多编码方式的坑,当时想填来着, ...

  8. java 变量与常量_详解Java变量与常量

    一.常量 用final修饰(也称最终变量) 常量在声明时必须赋初值,赋值后不能再修改值 常量名通常用全大写字母表示 声明时需要添加final或static final类型修饰符,例如: private ...

  9. java同步异步调用_详解java 三种调用机制（同步、回调、异步）

    1:同步调用:一种阻塞式调用,调用方要等待对方执行完毕才返回,jsPwwCe它是一种单向调用 2:回调:一种双向调用模式,也就是说,被调用方在接口被调用时也会调用对方的接口: 3:异步调用:一种类似消 ...

最新文章

  1. Jquery UI dialog 详解 (中文)
  2. 企业网络推广方案浅析网站优化中外链该怎么发布？
  3. 中软国际入职java考核_中软国际技术人员入职试题2(Java)
  4. 003_JavaScript实现
  5. easyui radio 取值和赋值
  6. 异常处理——Another app is currently holding the yum lock
  7. 推荐一个非常好用的以多tab标签方式打开windows CMD的工具
  8. Epic：把虚幻引擎推向所有游戏平台
  9. MyBatis3源码解析(8)MyBatis与Spring的结合
  10. 18.mysql优化（三）–explain分析sql语句执行效率
  11. 数据结构—平衡二叉树
  12. 在el-table中使用el-popover，没法点击确定或取消来关闭添加 多个按钮
  13. 【渝粤题库】陕西师范大学165101社会学 作业（高起专）
  14. 获取代理电脑的https证书方法
  15. 腾讯等公司python工程师面试题曝光！涨知识了
  16. vue路由守卫的执行顺序
  17. linux下内存测试mbw,内存测试工具mbw分析
  18. FTP：vsftpd中的local_umask和anon_umask
  19. Python处理Excel求取某列固定间隔数的平均值
  20. js html页面切换效果,jQuery实现切换页面过渡动画效果

热门文章

  1. 无线2.4G/5.8G国家信道
  2. 威纶触摸屏485直接控制监控台达vfd-m变频器方式
  3. 【8088】基于8088最小系统板的打地鼠游戏实现【简】
  4. plex 乱码_如何在Plex Media Server中存储和查看照片集
  5. 中国银行个人一手住房贷款合同
  6. [附源码]Nodejs计算机毕业设计基于框架的动漫设计Express(程序+LW)
  7. Object Detection-评价标准-AP mAP(2)
  8. 监控新星 | 实战Prometheus搭建监控系统
  9. 车机Radio 及RDS功能
  10. GDB内存调试初探八