文章目录
官方文档
https://baomidou.com/
引入
依赖
访问数据库,则mysql驱动必须添加。
MyBatisPlus是MyBatis的扩展。引入依赖时只需要引入MyBatisPlus,不要再引入MyBatis,否则可能会产生冲突。
<!-- 添加mysql驱动 -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<!--mybatis-plus-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.5.0</version>
</dependency>
指定mapper文件夹
为Application类添加@MapperScan
注解来指定mapper文件夹。
@SpringBootApplication
@MapperScan("com.example.test.system.mapper")//扫描mapper文件夹
public class TestApplication {
public static void main(String[] args) {
SpringApplication.run(TestApplication.class, args);
}
}
分页支持
MyBatisPlus分页使用IPage
,不需要额外引入依赖,但需要添加配置类:
@Configuration
public class MyBatisPlusConfig {
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
//向Mybatis过滤器链中添加分页拦截器
interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.MYSQL));
return interceptor;
}
}
若在Application
类中已经添加了@MapperScan
注解来指定mapper文件夹,这里就不需要重复添加。
特别注意IPage
与PageHelper
冲突。因此不要在pom.xml中引入PageHelper
。
自动生成
文件
MyBatisPlus可根据数据库表自动生成对应的4个文件夹:entity、controller、service、mapper。
自动生成需要添加依赖:
<!--mybatis-plus-generator-->
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-generator</artifactId>
<version>3.5.1</version>
</dependency>
在某个方法中添加自动生成逻辑。可以是某个controller方法,然后由系统调用;推荐放入Test方法,直接运行。
@RunWith(SpringRunner.class)
@SpringBootTest
public class Generator {
private final Logger logger = LoggerFactory.getLogger(Generator.class);
@Before
public void setUp() throws Exception {
logger.info("测试类Generator初始化");
}
@Test
public void autoGenerate() {
// 数据库信息
String url = "jdbc:mysql://localhost:3306/test?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8";
String userName = "root";
String password = "123456";
FastAutoGenerator.create(url, userName, password)
.globalConfig(builder -> {
builder.author("YuJian") // 设置作者
.enableSwagger() // 开启 swagger 模式
.fileOverride() // 覆盖已生成文件
.outputDir("E:\\workspace\\test\\src\\main\\java"); // 指定输出目录
})
.packageConfig(builder -> {
builder.parent("com.example.test") // 设置父包名
.moduleName("system"); // 设置父包模块名
// .pathInfo(Collections.singletonMap(OutputFile.mapperXml, "E:\\workspace\\test\\src\\main\\java")); // 设置mapperXml生成路径
})
.strategyConfig(builder -> {
builder.addInclude("user") // 设置需要生成的表名
.addTablePrefix("t_", "c_") // 设置过滤表前缀
.entityBuilder().enableLombok(); // 开启lombok,简化实体类
})
.templateEngine(new FreemarkerTemplateEngine()) // 使用Freemarker引擎模板,默认的是Velocity引擎模板
.execute();
}
}
运行后,即可在设置的文件夹下生成对应的文件。
若开启了swagger模式,则需要添加对应的swagger依赖。详见下文swagger支持。
注意其中xml的配置被注释掉了。若设施生成xml文件,当需要使用@SelectProvider
这样的注解时必须在xml文件中做对应的配置。因此若无特殊作用,可屏蔽xml文件生成的配置。
实体类
由于开启了lombok插件,自动生成的entity代码不带getter和setter。
@Getter
@Setter
@TableName(value = "sys_user")
public class User {
@TableId(type = IdType.AUTO)
private Integer id;
private String name;
private Integer age;
private String email;
}
可在实体类上使用@TableName
注解指定表名。若表名与类型相同,则该注解可省略。
在id
字段上使用了@TableId(type = IdType.AUTO)
来指明为自增长字段。具体属性名和属性值可参考文档。
实体类也封装了CRUD操作,需要继承Model
类。详见下文实体类 CRUD。
swagger支持
swagger通过在类及方法前添加对应的注解来自动生成在线文档。swagger支持有2种方式:
springfox-swagger2方式
springfox-swagger2
即swagger的官方导入方式。
首先添加依赖:
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger2</artifactId>
<version>2.9.2</version>
</dependency>
<!-- swagger-ui -->
<dependency>
<groupId>io.springfox</groupId>
<artifactId>springfox-swagger-ui</artifactId>
<version>2.9.2</version>
</dependency>
然后在启动类前添加注解:
@EnableSwagger2
添加配置类:
public class SwaggerConfig {
@Bean
public Docket createRestApi() {
List<Parameter> parameters = new ArrayList<Parameter>();
return new Docket(DocumentationType.SWAGGER_2)
.select()
.apis(RequestHandlerSelectors.basePackage("com.example.test.system.controller"))
.build()
.globalOperationParameters(parameters)
.apiInfo(apiInfo());
}
private ApiInfo apiInfo() {
return new ApiInfoBuilder()
.title("测试")
.contact(new Contact("test",null,null))
.version("1.0.0").build();
}
}
这样即导入完成。接下来在类或方法前添加@Api
、@ApiOperation
等swagger注解即可自动生成在线文档。
运行工程,在浏览器中访问地址:
http://localhost:8080/swagger-ui.html#/
spring4all方式
spring4all
是国人进行的封装,简化了依赖与配置。
首先添加依赖:
<!-- https://mvnrepository.com/artifact/com.spring4all/swagger-spring-boot-starter -->
<dependency>
<groupId>com.spring4all</groupId>
<artifactId>swagger-spring-boot-starter</artifactId>
<version>2.0.2.RELEASE</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-validation</artifactId>
</dependency>
注意spring4all的依赖在1.6版本前是spring-boot-starter-swagger,从1.6开始更新为swagger-spring-boot-starter。对于2.0版本后的swagger-spring-boot-starter,与当前最新的SpringBoot 2.6.3版本有冲突。因此若使用最新版本的SpringBoot,可以将swagger-spring-boot-starter的版本切换回1.9.1.RELEASE;若使用最新版本的swagger-spring-boot-starter,可以将SpringBoot切换回2.5.7。
同时,由于springboot2.3.1.RELEASE及以后版本不再自动引入validation
,因此在这里需要手动引入。
然后在启动类前添加注解:
@EnableSwagger2Doc
在Application.properties配置文件中添加配置:
#swagger配置
swagger.enabled=true
swagger.title=OSS服务
swagger.description=OSS基础服务API
swagger.version=1.0
swagger.base-package=com.example.test.system.controller
swagger.base-path=/**
swagger.exclude-path=/error
swagger.authorization.key-name=Authorization
这样即导入完成。接下来在类或方法前添加@Api
、@ApiOperation
等swagger注解即可自动生成在线文档。
运行工程,在浏览器中访问地址:
http://localhost:8080/swagger-ui.html#/
使用
CRUD接口封装
CRUD即增加(Create)、检索(Retrieve)、更新(Update)和删除(Delete)。MyBatisPlus已经做了封装,只要继承BaseMapper<T>
或IBaseService<T>
,即可直接为Service和Mapper赋予CRUD功能。
Mapper CRUD
Mapper CRUD需要在创建Mapper时继承BaseMapper<T>
:
public interface UserMapper extends BaseMapper<User> {
}
这样即实现了Mapper CRUD。Mapper CRUD包含如下功能:
- Insert: 插入。只包含单条记录插入。
- Delete: 删除。可根据条件进行单条或批量删除。
- Upate: 更新。
- Select: 查询。可根据条件进行单条或批量查询。单条查询只会返回类对象;批量查询时返回结果可为
List<T>
、List<Map<String, Object>>
、List<Object>
或IPage<T>
、IPage<Map<String, Object>>
。
Service CRUD
Service CRUD需要在创建Service时继承IService<T>
:
public interface UserService extends IService<User> {
}
这样即实现了Service CRUD。Service CRUD包含如下功能:
- Save: 插入。可进行单条插入或批量插入。对应Mapper的insert,但功能更强。
- Remove: 删除。可根据条件进行单条或批量删除。对应Mapper的Delete。
- Upate: 更新。
- Get: 查询单个。
- List: 查询批量。
- Page: 分页查询。
- Count: 查询数量。
- Chain: 链式查询。
实体类 CRUD
实体类也封装了CRUD操作,需要继承Model
类:
class User extends Model<User>{
// fields...
}
然后即可直接调用:
User user = new User();
user.insert();
user.selectAll();
user.updateById();
user.deleteById();
// ...
条件构造器
查询时可调用Wrapper来传入查询条件。
AbstractWrapper
为QueryWrapper(LambdaQueryWrapper)
和UpdateWrapper(LambdaUpdateWrapper)
的父类。其主要作用是生成sql的where条件。具体可参考官方文档。
条件通常由2个Wrapper子类负责:
- QueryWrapper: 用于生成查询类的sql条件。
- UpdateWrapper: 用于生成更新类的sql条件。
QueryWrapper
示例:
// 删除 id=1 的User
int r = userMapper.delete(new QueryWrapper<User>().eq("id", "1"));
// 删除 name=张三 并且 age=18 的User
int r = userMapper.delete(new QueryWrapper<User>().eq("name", "张三").eq("age", "18"));
// 删除 name=张三 或 name=李四 的User
int r = userMapper.delete(new QueryWrapper<User>().eq("name", "张三").or().eq("name", "李四"));
// 查询 name=张三 并且 age=18 的User
Map<String , Object> map = new HashMap<>();
map.put("name" , "张三");
map.put("age" , 18);
QueryWrapper<User> queryWrapper = new QueryWrapper<User>().allEq(map);
List<User> userList = userMapper.selectList(queryWrapper);
自定义查询
可使用@Select
和@SelectProvider
在mapper中进行自定义查询。
public interface UserMapper extends BaseMapper<User> {
@Select("SELECT * FROM user WHERE id=#{id};")
public User getUserById(Integer id);
@SelectProvider(type = UserProvider.class, method = "getUsers")
public List<User> getUsers();
}
public class UserProvider {
public String getUsers() {
String sql = "select * from user";
return sql;
}
}
注意若User对应的xml存在,则使用@SelectProvider
注解必须在xml中进行配置:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.example.test.system.mapper.UserMapper">
<select id="getUsers" resultType="com.example.test.system.entity.User"></select>
</mapper>
否则就会有错误提示:
Statement with id=“getUsers” not defined in mapper xml
若xml无其他作用,可直接将该xml删除,就不需要进行该配置了。
测试
通常地,使用SpringBoot自带的测试注解@SpringBootTest
标记测试类:
@RunWith(SpringRunner.class)
@SpringBootTest
public class TestService {
private final Logger logger = LoggerFactory.getLogger(TestService.class);
@Before
public void setUp() throws Exception {
logger.info("测试类TestControllerTest初始化");
}
// 自定义
@Test
public void doTest() throws Exception {
}
}
该方式会启动整个环境,即所有的服务。
MyBatisPlus在3.4.0版本引入了test starter:
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter-test</artifactId>
<version>3.5.0</version>
</dependency>
使用注解@MybatisPlusTest
标记测试类:
@RunWith(SpringRunner.class)
@MybatisPlusTest
@AutoConfigureTestDatabase(replace = AutoConfigureTestDatabase.Replace.NONE)
public class MybatisPlusSampleTest {
@Autowired
private UserMapper userMapper;
@Test
public void doTest() throws Exception {
}
}
该方式只会启动数据库服务和远程数据库,不会启动其他服务。
但实际测试,该方式可正常查询,但对于插入等操作,返回成功,但实际数据库未更改。因此建议依然使用SpringBoot自带测试。