MybatisPlus
快速入门
使用第三方插件
1、导入对应的依赖
2、研究依赖配置
3、代码编写
4、提高扩展技术能力
步骤
1、导入依赖
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.0.5</version>
</dependency>
2、配置配置文件
spring:
datasource:
username: root
password: 12345678
url: jdbc:mysql://localhost:3306/test?useSSL=false&useUnicode=true&characterEncoding=utf-8
3、编写实体类
@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {
private String username;
private String password;
}
4、编写mapper接口
@Mapper
public interface UserMapper extends BaseMapper<User> {
}
5、启动类添加包扫描
@MapperScan("com.lzl.mybatisplus.mapper") # 添加mapper文件路径
6、启动测试
@RestController
public class Controller {
@Autowired
private UserMapper userMapper;
@GetMapping("/test")
public List<User> test(){
List<User> users = userMapper.selectList(null);
for (User user : users) {
System.out.println(user);
}
return users;
}
}
7、配置日志
mybatis-plus:
configuration:
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
8、 主键id自动生成问题
public class User {
@TableId(type = IdType.AUTO) # 加入该注解 IdType.AUTO id自增 数据库需要设置自增
private Long id;
private String username;
private String password;
}
public enum IdType {
AUTO(0), # 数据库id自增
NONE(1), # 未设置主键
INPUT(2), # 手动输入
ID_WORKER(3), # 默认的全局唯一id
UUID(4), # 全局唯一id uuid
ID_WORKER_STR(5); #ID_WORKER 字符串表示法
}
数据库自动填入当前时间
-
方法一 在数据库中将数据类型设为timestamp 将数据库默认值改为CURRENT_TIMESTAMP
-
方法二
# 实体类中在相应字段加入@TbaleField 注解 插入使用file = fileldFile.INSERT # 更新使用 FieldFill.INSERT_UPDATE public class User { @TableId(type = IdType.AUTO) private Long id; private String username; private String password; @TableField(fill = FieldFill.INSERT_UPDATE) private Date time; } # 编写处理器 @Component #不要忘记将此容器加入到容器中 public class MyMetaObjectHandler implements MetaObjectHandler { @Override public void insertFill(MetaObject metaObject) { this.setFieldValByName("time",new Date(),metaObject); this.setFieldValByName("time",new Date(),metaObject); } @Override public void updateFill(MetaObject metaObject) { this.setFieldValByName("time",new Date(),metaObject); } }
乐观锁
数据库添加字段 实体类添加字段
@Version 在对应实体类字段上加如@Version字段
private Integer version;
注册组件
@Configuration
@EnableTransactionManagement
@MapperScan("com.lzl.mybatisplus.mapper")
public class MybatisConfig {
@Bean
public OptimisticLockerInterceptor optimisticLockerInterceptor(){
return new OptimisticLockerInterceptor();
}
}
查询操作
- selectById 根据id查单个用户
- selectByBatchId() 批量查询 参数为数组 例
userMapper.selectBatchIds(Arrays.asList(123, 1111)); #asList 方法 将此转为数组
条件查询 自定义条件查询
-
selectByMap(map)
Map<String, Object> map = new HashMap<>(); map.put("username","123"); List<User> users = userMapper.selectByMap(map);
分页查询
//Spring boot方式
@Configuration
@MapperScan("com.baomidou.cloud.service.*.mapper*")
public class MybatisPlusConfig {
// 最新版
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.H2));
return interceptor;
}
}
@Test
public void test3(){
Page page = new Page(1,5);//参数一 当前页 参数二 页面大小
userMapper.selectPage(page,null);
/*for (Object record : page.getRecords()) {
System.out.println(record);
}*/
page.getRecords().forEach(System.out::println);
}
删除操作
类似查询
-
deleteById 删除单个
-
deleteBatchIds() 批量删除
-
delectByMap() 通过map删除
逻辑删除
物理删除 : 从数据库中直接移除
逻辑删除 : 在数据库中没有移除,而是通过一个变量让他失效!delect=0=>delect=14
管理员可以查看被删除的记录,防止数据丢失,类似与回收站
添加字段控制是否逻辑删除
1、数据库添加deleted 字段
2、实体类中增加属性
3、实体类对应字段加入@TableLogic注解
@TableLogic
private Integer deleted;
4、 配置yaml文件
mybatis-plus:
global-config:
db-config:
logic-delete-field: flag # 全局逻辑删除的实体字段名(since 3.3.0,配置后可以忽略不配置步骤2)
logic-delete-value: 1 # 逻辑已删除值(默认为 1)
logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)
性能分析插件
作用 :
代码自动生成器
spring.profiles.active=dev 选择环境
public static String scanner(String tip) {
Scanner scanner = new Scanner(System.in);
StringBuilder help = new StringBuilder();
help.append("请输入" + tip + ":");
System.out.println(help.toString());
if (scanner.hasNext()) {
String ipt = scanner.next();
if (StringUtils.isNotBlank(ipt)) {
return ipt;
}
}
throw new MybatisPlusException("请输入正确的" + tip + "!");
}
public static void main(String[] args) {
// 代码生成器
AutoGenerator mpg = new AutoGenerator();
// 全局配置
GlobalConfig gc = new GlobalConfig();
String projectPath = System.getProperty("user.dir");
gc.setOutputDir(projectPath + "/src/main/java");
gc.setAuthor("jobob");
gc.setOpen(false);
// gc.setSwagger2(true); 实体属性 Swagger2 注解
mpg.setGlobalConfig(gc);
// 数据源配置
DataSourceConfig dsc = new DataSourceConfig();
dsc.setUrl("jdbc:mysql://localhost:3306/ant?useUnicode=true&useSSL=false&characterEncoding=utf8");
// dsc.setSchemaName("public");
dsc.setDriverName("com.mysql.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("密码");
mpg.setDataSource(dsc);
// 包配置
PackageConfig pc = new PackageConfig();
pc.setModuleName(scanner("模块名"));
pc.setParent("com.baomidou.ant");
mpg.setPackageInfo(pc);
// 自定义配置
InjectionConfig cfg = new InjectionConfig() {
@Override
public void initMap() {
// to do nothing
}
};
// 如果模板引擎是 freemarker
String templatePath = "/templates/mapper.xml.ftl";
// 如果模板引擎是 velocity
// String templatePath = "/templates/mapper.xml.vm";
// 自定义输出配置
List<FileOutConfig> focList = new ArrayList<>();
// 自定义配置会被优先输出
focList.add(new FileOutConfig(templatePath) {
@Override
public String outputFile(TableInfo tableInfo) {
// 自定义输出文件名 , 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化!!
return projectPath + "/src/main/resources/mapper/" + pc.getModuleName()
+ "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
}
});
/*
cfg.setFileCreate(new IFileCreate() {
@Override
public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
// 判断自定义文件夹是否需要创建
checkDir("调用默认方法创建的目录,自定义目录用");
if (fileType == FileType.MAPPER) {
// 已经生成 mapper 文件判断存在,不想重新生成返回 false
return !new File(filePath).exists();
}
// 允许生成模板文件
return true;
}
});
*/
cfg.setFileOutConfigList(focList);
mpg.setCfg(cfg);
// 配置模板
TemplateConfig templateConfig = new TemplateConfig();
// 配置自定义输出模板
//指定自定义模板路径,注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
// templateConfig.setEntity("templates/entity2.java");
// templateConfig.setService();
// templateConfig.setController();
templateConfig.setXml(null);
mpg.setTemplate(templateConfig);
// 策略配置
StrategyConfig strategy = new StrategyConfig();
strategy.setNaming(NamingStrategy.underline_to_camel);
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
strategy.setEntityLombokModel(true);
strategy.setRestControllerStyle(true);
// 公共父类
strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
// 写于父类中的公共字段
strategy.setSuperEntityColumns("id");
strategy.setInclude(scanner("表名,多个英文逗号分割").split(","));
strategy.setControllerMappingHyphenStyle(true);
strategy.setTablePrefix(pc.getModuleName() + "_");
mpg.setStrategy(strategy);
mpg.setTemplateEngine(new FreemarkerTemplateEngine());
mpg.execute();
}
自定义sql 使用三层结构
定义后可以使用内置mybatis_plus 方法
首先dao层
public interface UserMapper extends BaseMapper<User> {
}
service
public interface UserService extends IService<User>{
}
Iservice
@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {
}