详解SpringBoot快速整合Mybatis(去XML化+注解进阶)序⾔:使⽤MyBatis3提供的注解可以逐步取代XML,例如使⽤@Select注解直接编写SQL完成数据查询,使⽤
@SelectProvider⾼级注解还可以编写动态SQL,以应对复杂的业务需求。
⼀. 基础注解
MyBatis 主要提供了以下CRUD注解:
1. @Select
2. @Insert
3. @Update
4. @Delete
增删改查占据了绝⼤部分的业务操作,掌握这些基础注解的使⽤是很必要的。例如下⾯这段代码⽆需XML即可完成数据查询:
@Mapper
public 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主要提供这些映射注解:
1. @Results ⽤于填写结果集的多个字段的映射关系.
2. @Result ⽤于填写结果集的单个字段的映射关系.
3. @ResultMap 根据ID关联XML⾥⾯<resultMap>.
例如上⾯的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();
查询结果如下,:
[
{
"username": "admin",
"password": "admin",
"mobileNum": "150********"
},
{
"userId": "2",
"username": "roots",
"password": "roots",
"mobileNum": "188********"
}
]
为了⽅便演⽰和免除⼿⼯编写映射关系的烦恼,这⾥提供了⼀个快速⽣成映射结果集的⽅法,具体内容如下:
/**
* 1.⽤于获取结果集的映射关系
*/
public static String getResultsStr(Class origin) {
StringBuilder stringBuilder = new StringBuilder();
stringBuilder.append("@Results({\n");
for (Field field : DeclaredFields()) {
String property = Name();
//映射关系:对象属性(驼峰)->数据库字段(下划线)
String column = new PropertyNamingStrategy.SnakeCaseStrategy().Name()).toUpperCase();
stringBuilder.append(String.format("@Result(property = \"%s\", column = \"%s\"),\n", property, column));
}
stringBuilder.append("})");
String();
}
在当前Main⽅法执⾏效果如下:然后我们将控制台这段打印信息复制到接⼝⽅法上即可。
三. ⾼级注解
MyBatis-3 主要提供了以下CRUD的⾼级注解:
1. @SelectProvider
2. @InsertProvider
3. @UpdateProvider
4. @DeleteProvider
见名知意,这些⾼级注解主要⽤于动态SQL,这⾥以@SelectProvider 为例,主要包含两个注解属性,其中type表⽰⼯具类,method 表⽰⼯具类的某个⽅法,⽤于返回具体的SQL。
@Mapper
public 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&batis.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⽇志的控制台打印。在项⽬的资源⽬录中,添加 l 配置如下:
spring:
datasource:
#连接MySQL
url: jdbc:mysql://localhost:3306/socks?useSSL=false
username: root
password: root
driver-class-name: sql.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<User> 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.
* <p>
* ⽬标:使⽤Java⼯具类来替代传统的XML⽂件.(例如:UserSqlProvider.java <-- l)
*/
public class UserSqlProvider {
/**
* ⽅式1:在⼯具类的⽅法⾥,可以⾃⼰⼿⼯编写SQL。
*/
public String listByUsername(String username) {drop table if exists admin
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','150********');
INSERT INTO `t_user` VALUES ('2', 'roots', 'roots','188********');
4. 编写控制层代码
package ller;
@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) {
(username, password);
}
@GetMapping("get/bad/{username}/{password}")
public User getBadUser(@PathVariable("username") String username, @PathVariable("password") String password) { BadUser(username, password);
}
}
5. 启动和测试
版权声明:本站内容均来自互联网,仅供演示用,请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198,我们将在24小时内删除。
发表评论