在 Spring Boot 中使用 MyBatis
我們用一個(gè)獲取排行榜的小應(yīng)用作為例子球榆。
依賴與配置
- 引入所依賴的類庫(kù)蛔溃，在 MyBatis 的官網(wǎng)可以找到幔虏。接著引入 h2 數(shù)據(jù)庫(kù)所需的類庫(kù)胸梆。
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.1.3</version>
</dependency>
<dependency>
<groupId>com.h2database</groupId>
<artifactId>h2</artifactId>
<version>1.4.200</version>
</dependency>
- 配置 datasource
對(duì)于 Spring Boot 來(lái)說(shuō)硼控，需要進(jìn)行一些配置蚁飒，將 application.properties 放在 src/main/resources 下痊项。在官方文檔中可以找到锅风。
spring.datasource.url=jdbc:h2:file:./target/test
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=org.h2.Driver
- 配置 flyway 自動(dòng)化遷移插件以及 sql 初始化語(yǔ)句
在 src/main/resources/db/migration 下創(chuàng)建 V1__CreateTables.sql 用于初始化數(shù)據(jù)庫(kù)（一定注意這里是兩個(gè)下劃線，踩過(guò)坑）线婚。運(yùn)行 mvn flyway:migrate 初始化數(shù)據(jù)庫(kù)遏弱。這里不贅述細(xì)節(jié)。
create table user
(
id bigint primary key auto_increment,
name varchar(100)
)
create table match
(
id bigint primary ket auto_increment,
user_id bigint,
score int
)
insert into user (id, name) values (1, 'AAA');
insert into user (id, name) values (2, 'BBB');
insert into user (id, name) values (3, 'CCC');
insert into match (id, user_id, score) values (1, 1, 1000);
insert into match (id, user_id, score) values (2, 1, 2000);
insert into match (id, user_id, score) values (3, 2, 500);
insert into match (id, user_id, score) values (4, 3, 300);
<plugin>
<groupId>org.flywaydb</groupId>
<artifactId>flyway-maven-plugin</artifactId>
<version>7.4.0</version>
<configuration>
<url>jdbc:h2:file:./target/test</url>
<user>root</user>
<password>root</password>
</configuration>
</plugin>
- 配置 MyBatis
在 application.properties 中加入
mybatis.config-location = classpath:db/mybatis/config.xml
在 db/mybatis/config.xml 中寫入 mybatis 配置塞弊，同樣我們?cè)?a target="_blank">官網(wǎng)抄漱逸。值得注意的是我們?cè)赟pring datasource中已經(jīng)配置好了環(huán)境，所以mybatis中的<environments></environments> 環(huán)境配置部分可以全都不要游沿。
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
<mappers>
<mapper resource="db/mybatis/MyMapper.xml"/>
</mappers>
</configuration>
兩種方式使用 MyBatis
- 注解
注意這里是接口不是類
@Mapper
public interface UserMapper {
@Select("select * from user where id = #{id}")
User getUserById(@Param("id") Integer id);
}
在config.xml 中加入mapper
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
<mappers>
<mapper resource="db/mybatis/MyMapper.xml"/>
<mapper class="hello.dao.UserMapper"/>
</mappers>
</configuration>
@RestController
public class HelloController {
@Autowired
private UserMapper userMapper;
@RequestMapping("/")
@ResponseBody
public Object index() {
return userMapper.getUserById(1);
}
}
- xml
我們使用 xml 寫好 mapper饰抒。
<?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="MyMapper">
<select id="selectRank" resultMap="rankItem">
select user.id, user.name as name, total_score as score
from
(select user_id, sum(score) as total_score, from match group by user_id) m
join user
on m.user_id = user.id
</select>
<resultMap id="rankItem" type="hello.entity.RankItem">
<result property="score" column="score"/>
<association property="user" javaType="hello.entity.User">
<result property="name" column="name"/>
<result property="id" column="id"/>
</association>
</resultMap>
</mapper>
如何讓 Spring 容器知道一個(gè)類是一個(gè)Bean（可以被注入，需要被注入等）诀黍，一種簡(jiǎn)單的方法就是在 class 上使用注解 @Service 或者 @Component袋坑。換一句話說(shuō)只有聲明了 @Service，Bean才能被識(shí)別或是自動(dòng) Autowired眯勾。還有一種較為復(fù)雜的聲明 Bean 的方式枣宫，這里先不展開(kāi)∑攀模現(xiàn)在問(wèn)題來(lái)了，我們知道在使用MyBatis時(shí)也颤，我們需要一個(gè) SqlSessionFactory 和一個(gè) SqlSession 才能完成一系列 select 操作洋幻。但是在 Spring Boot 中這些東西從哪來(lái)呢？既然我們?cè)谑褂?Spring翅娶，那么所有的依賴都需要 Spring 自動(dòng)幫我們完成文留，這個(gè)時(shí)候非常簡(jiǎn)單。我們只需要自動(dòng)注入一個(gè) SqlSession 就好了竭沫，Spring 會(huì)自動(dòng)幫你完成依賴的裝配和注入燥翅，然后就直接用它吧。
@Service
public class RankDao {
@Autowired
private SqlSession sqlSession;
public List<RankItem> getRank() {
return sqlSession.selectList("MyMapper.selectRank");
}
}
@Service
public class RankService {
@Autowired
private RankDao rankDao;
public List<RankItem> getRank() {
return rankDao.getRank();
}
}
@RestController
public class HelloController {
@Autowired
private RankService rankService;
@RequestMapping("/")
@ResponseBody
public Object index() {
return rankService.getRank();
}
}
頁(yè)面渲染
后端渲染
我們考慮使用模板引擎蜕提，模板引擎有 freemaker森书、jsp、velocity 贯溅。目前最流行的模板引擎是 Freemaker拄氯。與 MyBatis 相似，F(xiàn)reemaker 也有一個(gè) spring-boot-starter-freemaker 的依賴類庫(kù)它浅。我們需要在 resources/templates 目錄下創(chuàng)建 .ftlh 格式的模板文件，還需要排行榜的數(shù)據(jù)镣煮。我們稱這種響應(yīng) HTTP 的方式叫做 Model And View姐霍。有如下的寫法：
// html.ftlh
<!DOCTYPE html>
<html lang="zh-CN">
<head>
<title>排行榜</title>
</head>
<body>
<table>
<tr>
<th>排名</th>
<th>名字</th>
<th>分?jǐn)?shù)</th>
</tr>
<tr>
<td>${index}</td>
<td>${name}</td>
<td>${score}</td>
</tr>
</table>
</body>
</html>
@RestController
public class HelloController {
@RequestMapping("/")
public ModelAndView index() {
Map<String, Object> model = new HashMap<>();
model.put("index", 1);
model.put("name", "Zhang San");
model.put("score", 1000);
return new ModelAndView("index", model);
}
}
根據(jù) Freemaker 的語(yǔ)法，把所有數(shù)據(jù)填上去就可以了典唇。
<!DOCTYPE html>
<html lang="zh-CN">
<head>
<title>排行榜</title>
</head>
<body>
<table>
<tr>
<th>排名</th>
<th>名字</th>
<th>分?jǐn)?shù)</th>
</tr>
<#list items as item>
<tr>
<td>${item?index+1}</td>
<td>${item.user.name}</td>
<td>${item.score}</td>
</tr>
</#list>
</table>
</body>
</html>
@RestController
public class HelloController {
@Autowired
private RankService rankService;
@RequestMapping("/")
public ModelAndView index() {
List<RankItem> items = rankService.getRank();
Map<String, List<RankItem>> model = new HashMap<>();
model.put("items", items);
return new ModelAndView("index", model);
}
}
前段渲染
使用 JS 和 JSON 異步請(qǐng)求進(jìn)行前端渲染镊折。在 resources/static 下創(chuàng)建 index.html。Spring 規(guī)定在resource/static 目錄下的文件可以直接訪問(wèn)介衔。前端只需要用 ajax 訪問(wèn)某個(gè)接口獲取數(shù)據(jù)恨胚，前端使用 js 動(dòng)態(tài)的把數(shù)據(jù)加載到 html 上。
