第一步:导入依赖
除了mapper-spring-boot-starter通用mapper外,其他都是配合测试的依赖
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<dependency>
<groupId>tk.mybatis</groupId>
<artifactId>mapper-spring-boot-starter</artifactId>
<version>2.1.5</version>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>com.github.pagehelper</groupId>
<artifactId>pagehelper-spring-boot-starter</artifactId>
<version>1.3.0</version>
</dependency>
第二步:配置yml
暂时无需做通用mapper配置,先配置基础启动部分内容,这里启动类、yml自行编写
server:
port: 8088
spring:
application:
name: your-service-name
datasource:
driver-class-name: com.mysql.cj.jdbc.Driver
url: jdbc:mysql://${MYSQL_HOST:localhost}:${MYSQL_PORT:3306}/${MYSQL_DB:your database}?characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=false&useJDBCCompliantTimezoneShift=true&useLegacyDatetimeCode=false&serverTimezone=GMT%2B8&nullCatalogMeansCurrent=true&allowPublicKeyRetrieval=true
username: ${MYSQL-USER:root}
password: ${MYSQL-PWD:root}
第三步:配置启动类
要加这个包扫描路径@MapperScan(basePackages = "com.nico.mybatis.mapper"),先注释掉
//@MapperScan(basePackages = "com.nico.mybatis.mapper")
@SpringBootApplication
public class MyMybatisApplication {
public static void main(String[] args) {
SpringApplication.run(MyMybatisApplication.class,args);
}
}
用另一种方式@Mapper绑定CastMenuConfigMapper
@Mapper
public interface CastMenuConfigMapper {
CastMenuConfig findById(String id);
// @Select("select * from cast_menu_config")
List<CastMenuConfig> findAll();
@Select("select * from cast_menu_config")
List<CastMenuConfig> findPage();
}
第四步:准备测试
看看你的实体类好了没有,数据库连起来没有,好的先看实体类,这里避免太长只贴部分字段 get set方法省略了,最好重写个toString方法,方便控制台打印查看
@Table(name = "cast_menu_config")
public class CastMenuConfig implements Serializable {
@Id
@Column(name = "id")
private Long id; //主键
@Column(name = "menu_name")
private String menuName; //菜单名称
@Column(name = "menu_type")
private int menuType; //菜单类型
@Column(name = "menu_sort")
private int menuSort; //菜单顺序
//get set此处省略。。。
@Override
public String toString() {
return "CastMenuConfig{" +
"id=" + id +
", liveBasicId=" + liveBasicId +
", menuName='" + menuName + '\'' +
", menuType=" + menuType +
", menuSort=" + menuSort +
'}';
}
}
看一下数据库
好的,再把CastMenuConfigMapper.xml 文件配置一下,namespace的包路径为上面CastMenuConfigMapper 接口的包路径,resultType="CastMenuConfig"是通过yml中这个配置的包路径 type-aliases-package: com.nico.mybatis.entity找到对应实体类CastMenuConfig的,还有接口方法名findById和 id="findById"是对应一致的,好了不再疑惑,继续看
<?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.nico.mybatis.mapper.CastMenuConfigMapper">
<select id="findById" parameterType="String" resultType="CastMenuConfig">
select * from cast_menu_config where id=#{id}
</select>
<select id="findAll" parameterType="String" resultType="CastMenuConfig">
select * from cast_menu_config
</select>
</mapper>
再看看项目文件结构,test里面的内容是创建测试类生成的,当然你可以创建controller和业务层service代码,通过postman或浏览器发起访问完成整个调用逻辑,但是这里通过测试来快速访问。
第五步:进入测试
先创建一个测试类
点击ok后就生成了测试类,由上面的文件结构可以看到在test目录下的文件CastMenuConfigMapperTest
@SpringBootTest
class CastMenuConfigMapperTest {
@Autowired
private CastMenuConfigMapper castMenuConfigMapper;
@Test
void findById() {
CastMenuConfig castMenuConfig = castMenuConfigMapper.findById("1322078827776266241");
System.out.println("查询结果:"+castMenuConfig);
}
@Test
void findAll() {
List<CastMenuConfig> castMenuConfigList = castMenuConfigMapper.findAll();
castMenuConfigList.forEach(item->System.out.println("查询结果:"+item));
}
@Test
void findPage() {
PageHelper.startPage(1,2);
List<CastMenuConfig> castMenuConfigList = castMenuConfigMapper.findPage();
PageInfo<CastMenuConfig> castMenuConfigPageInfo = new PageInfo<>(castMenuConfigList);
castMenuConfigPageInfo.getList().forEach(item->System.out.println("查询结果:"+item));
}
}
写好参数,好了,点击测试
发现测试没有通过报错了,表示找不到绑定的mapper
org.apache.ibatis.binding.BindingException: Invalid bound statement (not found): com.nico.mybatistk.mapper.CastMenuConfigMapper.findAll
试试其他方法测试,一样报错(此时我把CastMenuConfigMapper里findAll() 注解 // @Select("select * from cast_menu_config")注释了)我们把注释放开测试通过了,但是字段属性值都为null,说明映射有问题
报错是因为没有在yml里配置mapper-locations: classpath:mapper/*.xml,所以找不到这个文件报错,@Mapper和@MapperScan注解二选一都是支持的,用@select(sql)这种注解方式它不需要找xml文件就可以执行sql,然后修改yml添加配置
mybatis:
mapper-locations: classpath:mapper/*.xml
type-aliases-package: com.nico.mybatistk.entity
configuration:
# log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
map-underscore-to-camel-case: true
测试结果,打印sql,返回实体都有值了,一切都正常了,所以如果使用xml方式映射sql那么必须配置以上内容
好的,我们现在注释掉这些配置,用注解的形式测试一下
注解方式是没问题的,和我上一篇整合mybatis基本一致,通用mapper除了定义了一些增删改查的接口其他都是兼容mybatis的所有功能的。
第六步:通用mapper提供的常用接口
通用mapper给我们封装了许多接口可以直接调用,其中做查询的接口比较丰富
我们用selectByPrimaryKey这个接口测试一下,结果是ok的
使用Example构造查询条件,进行查询
总结:
这个Example和MyBatis-Plus中的条件构造器QueryWrapper是异曲同工的,下一篇会讲到,更多功能自行拓展,这里只做快速集成整合。