Mybatis-Plus(简称 MP)是一个 Mybatis的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。
官网: https://baomidou.com/

Next

创建成功

org.springframework.boot spring-boot-starter-webcom.baomidou mybatis-plus-spring-boot3-starter3.5.5 com.mysql mysql-connector-jcom.alibaba druid-spring-boot-starter1.1.18 org.projectlombok lombokorg.springframework.boot spring-boot-starterorg.springframework.boot spring-boot-starter-freemarker
由于个人习惯用yml格式配置,将配置文件application.properties后缀改为了yml
spring:
application:
name: mybatis-plus-demo
datasource:
type: com.alibaba.druid.pool.DruidDataSource
username: root # 这里替换成自己的用户名
password: 123456 # 这里替换成自己的密码
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://localhost/metest
# mybatis-plus配置
mybatis-plus:
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl #日志
map-underscore-to-camel-case: true #开启驼峰命名
CREATE DATABASE `metest`; USE `metest`; DROP TABLE IF EXISTS `user`; CREATE TABLE `user` ( `id` bigint NOT NULL AUTO_INCREMENT COMMENT '用户id', `user_name` varchar(50) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL DEFAULT NULL COMMENT '用户名', `password` varchar(50) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL DEFAULT NULL COMMENT '用户密码', `nick_name` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL DEFAULT NULL COMMENT '用户昵称', `email` varchar(255) CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL DEFAULT NULL COMMENT '用户邮箱', `remark` text CHARACTER SET utf8mb4 COLLATE utf8mb4_0900_ai_ci NULL COMMENT '备注', PRIMARY KEY (`id`) USING BTREE ) ENGINE = InnoDB CHARACTER SET = utf8mb4 COLLATE = utf8mb4_0900_ai_ci ROW_FORMAT = Dynamic;
@SpringBootApplication
// 替换为自己的mapper路径
@MapperScan(basePackages = "com.dm.mybatisplus.mapper")
public class MybatisPlusDemoApplication {
public static void main(String[] args) {
SpringApplication.run(MybatisPlusDemoApplication.class, args);
}
}
@Data
public class User {
@TableId(type = IdType.AUTO)
private Long id;
private String userName;
private String password;
private String nickName;
private String email;
private String remark;
// 因为引入了lombok依赖,使用@Data注解可代替getter/setter方法
}
@Repository public interface UserMapper extends BaseMapper{ }
BaseMapper类是 MyBatis-Plus 框架中的一个核心接口,用于提供基本的 CRUD(创建、读取、更新、删除)操作的方法定义。它通过继承 MyBatis 的 Mapper 接口并扩展了一些常用的数据库操作方法,使得开发人员可以更加便捷地进行数据访问层的开发,无需手动编写对应的 SQL 语句。泛型为实体类
service
public interface UserService extends IService{ }
IService主要是集成了一些通用的服务方法,和普通的Service接口一样。
serviceImpl
@Service public class UserServiceImpl extends ServiceImplimplements UserService { }
ServiceImpl主要是IService的实现类,传入的参数为M和T。
M:Mapper接口类型;T:对应实体类的类型
解释:
@RestController
@RequestMapping("user")
public class UserController {
@Autowired
private UserService userService;
/**
* 获取用户列表
* @return
*/
@GetMapping
public List users(){
List list = userService.list();
return list;
}
/**
* 根据id获取用户信息
* @param id
* @return
*/
@GetMapping("{id}")
public User user(@PathVariable Long id){
User user = userService.getById(id);
return user;
}
/**
* 新增用户信息
* @return
*/
@PostMapping
public boolean save() {
// 模拟前端传输的数据
User user = new User();
user.setUserName("zhangsan");
user.setPassword("123456");
user.setNickName("张三");
user.setEmail("123456@163.com");
user.setRemark("备注内容xxx");
boolean save = userService.save(user);
return save;
}
/**
* 根据id修改用户信息
* @return
*/
@PutMapping
public boolean update() {
// 模拟前端传输的数据
User user = new User();
user.setId(1L);
user.setUserName("lisi");
user.setNickName("李四");
boolean save = userService.updateById(user);
return save;
}
/**
* 根据删除用户信息
* @return
*/
@DeleteMapping("{id}")
public boolean delete(@PathVariable Long id){
return userService.removeById(id);
}
}
好了,以上就是springboot整合mybatis-plus的一些简单的CRUD。
@Data
@TableName("user")
public class User {
private Long id;
private String userName;
private String password;
private String nickName;
private String email;
private String remark;
}
| 属性 | 必须指定 | 类型 | 默认值 | 描述 |
|---|---|---|---|---|
| value | String | 否 | “” | 表名 |
| schema | String | 否 | “” | schema |
| keepGlobalPrefix | boolean | 否 | false | 是否保持使用全局的 tablePrefix 的值(当全局 tablePrefix 生效时) |
| resultMap | String | 否 | “” | xml 中 resultMap 的 id(用于满足特定类型的实体类对象绑定) |
| autoResultMap | boolean | 否 | false | 是否自动构建 resultMap 并使用(如果设置 resultMap 则不会进行 resultMap 的自动构建与注入) |
| excludeProperty | String[] | 否 | {} | 需要排除的属性名 @since 3.3.1 |
关于 autoResultMap 的说明:
MP 会自动构建一个 resultMap 并注入到 MyBatis 里(一般用不上),请注意以下内容:
因为 MP 底层是 MyBatis,所以 MP 只是帮您注入了常用 CRUD 到 MyBatis 里,注入之前是动态的(根据您的 Entity 字段以及注解变化而变化),但是注入之后是静态的(等于 XML 配置中的内容)。
而对于 typeHandler 属性,MyBatis 只支持写在 2 个地方:
1、定义在 resultMap 里,作用于查询结果的封装
2、定义在 insert 和 update 语句的 #{property} 中的 property 后面(例:#{property,typehandler=xxx.xxx.xxx}),并且只作用于当前 设置值
除了以上两种直接指定 typeHandler 的形式,MyBatis 有一个全局扫描自定义 typeHandler 包的配置,原理是根据您的 property 类型去找其对应的 typeHandler 并使用。
@Data
@TableName("user")
public class User {
@TableId(type = IdType.AUTO)
private Long id;
private String userName;
private String password;
private String nickName;
private String email;
private String remark;
}
| 属性 | 类型 | 必须指定 | 默认值 | 描述 |
|---|---|---|---|---|
| value | String | 否 | “” | 主键字段名 |
| type | Enum | 否 | IdType.NONE | 指定主键类型 |
IdType
| 值 | 描述 |
|---|---|
| AUTO | 数据库ID自增 |
| NONE | 无状态,该类型为未设置主键类型(注解里等于跟随全局,全局里约等于 INPUT) |
| INPUT | insert 前自行 set 主键值 |
| ASSIGN_ID | 分配 ID(主键类型为 Number(Long 和 Integer)或 String)(since 3.3.0),使用接口IdentifierGenerator的方法nextId(默认实现类为DefaultIdentifierGenerator雪花算法) |
| ASSIGN_UUID | 分配 UUID,主键类型为 String(since 3.3.0),使用接口IdentifierGenerator的方法nextUUID(默认 default 方法) |
| 分布式全局唯一 ID 长整型类型(please use ASSIGN_ID) | |
| 32 位 UUID 字符串(please use ASSIGN_UUID) | |
| 分布式全局唯一 ID 字符串类型(please use ASSIGN_ID) |
@Data
@TableName("user")
public class User {
@TableId(type = IdType.AUTO)
private Long id;
@TableField("user_name")
private String userName;
private String password;
private String nickName;
private String email;
private String remark;
}
| 属性 | 类型 | 必须指定 | 默认值 | 描述 |
|---|---|---|---|---|
| value | String | 否 | “” | 数据库字段名 |
| exist | boolean | 否 | true | 是否为数据库表字段 |
| condition | String | 否 | “” | 字段 where 实体查询比较条件,有值设置则按设置的值为准,没有则为默认全局的 %s=#{%s},参考(opens new window) |
| update | String | 否 | “” | 字段 update set 部分注入,例如:当在version字段上注解update=“%s+1” 表示更新时会 set version=version+1 (该属性优先级高于 el 属性) |
| insertStrategy | Enum | 否 | FieldStrategy.DEFAULT | 举例:NOT_NULLinsert into table_a(column) values (#{columnProperty}) |
| updateStrategy | Enum | 否 | FieldStrategy.DEFAULT | 举例:IGNOREDupdate table_a set column=#{columnProperty} |
| whereStrategy | Enum | 否 | FieldStrategy.DEFAULT | 举例:NOT_EMPTYwhere column=#{columnProperty} |
| fill | Enum | 否 | FieldFill.DEFAULT | 字段自动填充策略 |
| select | boolean | 否 | true | 是否进行 select 查询 |
| keepGlobalFormat | boolean | 否 | false | 是否保持使用全局的 format 进行处理 |
| jdbcType | JdbcType | 否 | JdbcType.UNDEFINED | JDBC 类型 (该默认值不代表会按照该值生效) |
| typeHandler | Class extends TypeHandler> | 否 | UnknownTypeHandler.class | 类型处理器 (该默认值不代表会按照该值生效) |
| numericScale | String | 否 | “” | 指定小数点后保留的位数 |
关于`jdbcType`和`typeHandler`以及`numericScale`的说明: numericScale只生效于 update 的 sql. jdbcType和typeHandler如果不配合@TableName#autoResultMap = true 一起使用,也只生效于 update 的 sql. 对于typeHandler如果你的字段类型和 set 进去的类型为equals关系, 则只需要让你的typeHandler让 Mybatis 加载到即可,不需要使用注解
使用mybatis-plus的分页时,必须配置MybatisPlusConfig,否则分页插件不生效
@Configuration
public class MybatisPlusConfig {
/**
* 添加分页插件
*/
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));//如果配置多个插件,切记分页最后添加
//interceptor.addInnerInterceptor(new PaginationInnerInterceptor()); 如果有多数据源可以不配具体类型 否则都建议配上具体的DbType
return interceptor;
}
}
/**
* 分页查询用户信息
* @return
*/
@GetMapping("page")
public IPage findUserByPage(){
// 当前页码
long current = 1;
// 每页记录数
long size = 5;
IPage page = new Page<>(current,size);
// 分页查询
page = userService.page(page);
return page;
}
完活,现在分页也就没问题啦!
com.baomidou
mybatis-plus-generator
3.5.6
public class MyBatisPlusGenerator {
public static void main(String[] args) {
String url = "jdbc:mysql://127.0.0.1:3306/metest"; // 自己的url
String username = "root"; // 自己的用户名
String password = "123456"; // 自己的密码
FastAutoGenerator.create(url, username, password)
.globalConfig(builder -> {
builder.author("java动脉") // 作者
.commentDate("yyyy-MM-dd hh:mm:ss")
.dateType(DateType.TIME_PACK)
.disableOpenDir()
.enableSwagger() // 开启 swagger 模式
.outputDir(System.getProperty("user.dir") + "/src/main/java"); // 指定输出目录
})
.dataSourceConfig(builder -> builder.typeConvertHandler((globalConfig, typeRegistry, metaInfo) -> {
int typeCode = metaInfo.getJdbcType().TYPE_CODE;
if (typeCode == Types.SMALLINT) {
// 自定义类型转换
return DbColumnType.INTEGER;
}
return typeRegistry.getColumnType(metaInfo);
}))
.packageConfig(builder -> {
builder.parent("com.dm.plus") // 设置父包名
.moduleName("system") // 设置父包模块名
.pathInfo(Collections.singletonMap(OutputFile.mapper.xml, System.getProperty("user.dir")+"/src/main/resources/mapper")); // 设置mapperXml生成路径
})
.strategyConfig(builder -> {
builder.addInclude("user") // 设置需要生成的表名
.addTablePrefix("t_", "c_"); // 设置过滤表前缀
})
.templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板,默认的是Velocity引擎模板
.execute();
}
}
完活~~