最近在研究 mybatis,然后就去找简化 mybatis 开发的工具,发现就有通用 Mapper 和 mybatis-plus 两个比较好的可是使用,可是经过对比发现还是 mybatis-plus 比较好,个人觉得,勿喷。。。
集成还是非常简单的,然后就在研究怎么分页,开始研究通用 mapper 时发现有个 pagehelper 的分页工具可以和它搭配。然后反过来看是不是也可以和 mybatis-plus 搭配使用呢?发现 mybatis-plus 之前是可以支持的,升级成 3.X 之后就不再支持了。然后就研究 mybatis-plus 自带的分页工具吧!今天就简单的写个例子吧!
- 首先我们肯定要先建一个 springboot 的项目,这里我就不再多说怎么创建了昂,不会的话请参考
Spring Boot 的简单教程(一)Spring Boot 项目的创建 - 创建好项目之后我们就需要配置 maven 依赖了,这里附上我的 pom.xml 文件了。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.0.1</version>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
<!-- 这是 mybatis-plus 依赖 -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.1.1</version>
</dependency>
<!-- 这是 mybatis-plus 的代码自动生成器 -->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.1.1</version>
</dependency>
<!-- 这是模板引擎依赖 -->
<dependency>
<groupId>org.freemarker</groupId>
<artifactId>freemarker</artifactId>
<version>2.3.28</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
- 配置好 pom.xml 文件之后,理所当然的就需要配置 application.yml 了。
#端口号
server:
port: 8888
#数据库的配置信息
spring:
datasource:
url: jdbc:mysql://localhost:3306/blog #自己的数据库名称
username: root
password: 123456
mybatis:
#开启驼峰命名法
configuration:
map-underscore-to-camel-case: true
mybatis-plus:
# xml 地址
mapper-locations: classpath:mapper/*Mapper.xml
# 实体扫描,多个 package 用逗号或者分号分隔
type-aliases-package: com.zhouzhaodong.pagination.entity #自己的实体类地址
configuration:
# 这个配置会将执行的 sql 打印出来,在开发或测试的时候可以用
log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
- 接下来就需要配置 mybatis-plus 的代码生成器了。
/**
* <p>
* 读取控制台内容
* </p>
*/
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.isNotEmpty(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/blog?useUnicode=true&useSSL=false&characterEncoding=utf8");
// dsc.setSchemaName("public");
dsc.setDriverName("com.mysql.cj.jdbc.Driver");
dsc.setUsername("root");
dsc.setPassword("123456");
mpg.setDataSource(dsc);
// 包配置
PackageConfig pc = new PackageConfig();
// 这里有个模块名的配置,可以注释掉不用。// pc.setModuleName(scanner("模块名"));
// pc.setParent("com.zhouxiaoxi.www");
pc.setParent(scanner("模块地址"));
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("调用默认方法创建的目录");
return false;
}
});
*/
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);
// 数据库表字段映射到实体的命名策略, 未指定按照 naming 执行
strategy.setColumnNaming(NamingStrategy.underline_to_camel);
// 自定义继承的 Entity 类全称,带包名
// strategy.setSuperEntityClass("***");
strategy.setEntityLombokModel(true);
strategy.setRestControllerStyle(true);
// 自定义继承的 Controller 类全称,带包名
// strategy.setSuperControllerClass("***");
strategy.setInclude(scanner("表名,多个英文逗号分割").split(","));
// 自定义基础的 Entity 类,公共字段(可添加更多)// strategy.setSuperEntityColumns("id");
// 驼峰转连字符
strategy.setControllerMappingHyphenStyle(true);
// 表前缀
// strategy.setTablePrefix(pc.getModuleName() + "_");
mpg.setStrategy(strategy);
mpg.setTemplateEngine(new FreemarkerTemplateEngine());
mpg.execute();}
运行之后就会出现所有需要的文件了。
- 需要配置一下分页插件,新建一个文件 MybatisPlusConfig。
//Spring boot 方式
@EnableTransactionManagement
@Configuration
public class MybatisPlusConfig {
/**
* 分页插件
*/
@Bean
public PaginationInterceptor paginationInterceptor() {return new PaginationInterceptor();
}
}
- 这样就只需要在 controller 里面写方法就可以了。
@RestController
@RequestMapping("/student")
public class StudentController {
@Autowired
IStudentService studentService;
@RequestMapping(value = "/findAll",method = RequestMethod.POST)
public Object findAll(HttpServletRequest request){
// 获取前台发送过来的数据
Integer pageNo = Integer.valueOf(request.getParameter("pageNo"));
Integer pageSize = Integer.valueOf(request.getParameter("pageSize"));
IPage<Student> page = new Page<>(pageNo, pageSize);
QueryWrapper<Student> wrapper = new QueryWrapper<>();
Student student = new Student();
student.setId(1);
wrapper.setEntity(student);
return studentService.page(page,wrapper);
}
}
- 实现的效果为:
具体代码在 github 上面已经上传了,可以去下载使用哦!
https://github.com/zhouzhaodo…