你不知道的SpringBoot 快速整合Mybatis(去XML化+注解进阶)

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

如果大家对于学习Java有任何问题(学习方法,学习效率,如何就业),可以随时来咨询我,这是我的Java交流学习群: 934623944大家多多交流问题,互帮互助,群里有不错的学习教程和开发工具。备注:简书

一. 基础注解

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

如果大家对于学习Java有任何问题(学习方法,学习效率,如何就业),可以随时来咨询我,这是我的Java交流学习群: 934?623?944大家多多交流问题,互帮互助,群里有不错的学习教程和开发工具。备注:CSDN

三. 高级注解

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 ;

}

四. 详细教程

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

具体步骤

引入依赖

为了方便演示,首选搭建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>

添加配置

这里主要是添加数据源,配置驼峰映射和开启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<User> 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<User> 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 List<User> list() {

    return userMapper.list();

}

@GetMapping("list/{username}")

public List<User> 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);

如果大家对于学习Java有任何问题(学习方法,学习效率,如何就业),可以随时来咨询我,这是我的Java交流学习群: 934623944大家多多交流问题,互帮互助,群里有不错的学习教程和开发工具。备注:简书

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 195,980评论 5 462
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 82,422评论 2 373
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 143,130评论 0 325
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 52,553评论 1 267
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 61,408评论 5 358
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 46,326评论 1 273
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 36,720评论 3 386
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 35,373评论 0 254
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 39,678评论 1 294
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 34,722评论 2 312
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 36,486评论 1 326
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 32,335评论 3 313
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 37,738评论 3 299
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,009评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 30,283评论 1 251
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 41,692评论 2 342
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 40,893评论 2 335

推荐阅读更多精彩内容