Java Web現代化開發:Spring Boot + Mybatis + Redis二級緩存
背景
Spring-Boot因其提供了各種開箱即用的插件,使得它成爲了當今最爲主流的Java Web開發框架之一。Mybatis是一個十分輕量好用的ORM框架。Redis是當今十分主流的分佈式key-value型數據庫,在web開發中,我們常用它來緩存數據庫的查詢結果。
本篇博客將介紹如何使用Spring-Boot快速搭建一個Web應用,並且採用Mybatis作爲我們的ORM框架。爲了提升性能,我們將Redis作爲Mybatis的二級緩存。爲了測試我們的代碼,我們編寫了單元測試,並且用H2內存數據庫來生成我們的測試數據。通過該項目,我們希望讀者可以快速掌握現代化Java Web開發的技巧以及最佳實踐。
本文的示例代碼可在Github中下載:https://github.com/Lovelcp/spring-boot-mybatis-with-redis/tree/master
環境
- 開發環境:mac 10.11
- ide:Intellij 2017.1
- jdk:1.8
- Spring-Boot:1.5.3.RELEASE
- Redis:3.2.9
- Mysql:5.7
Spring-Boot
新建項目
首先,我們需要初始化我們的Spring-Boot工程。通過Intellij的Spring Initializer,新建一個Spring-Boot工程變得十分簡單。首先我們在Intellij中選擇New一個Project:
然後在選擇依賴的界面,勾選Web、Mybatis、Redis、Mysql、H2:
新建工程成功之後,我們可以看到項目的初始結構如下圖所示:
Spring Initializer已經幫我們自動生成了一個啓動類——SpringBootMybatisWithRedisApplication。該類的代碼十分簡單:
@SpringBootApplication
public class SpringBootMybatisWithRedisApplication {
public static void main(String[] args) {
SpringApplication.run(SpringBootMybatisWithRedisApplication.class, args);
}
}
@SpringBootApplication註解表示啓用Spring Boot的自動配置特性。好了,至此我們的項目骨架已經搭建成功,感興趣的讀者可以通過Intellij啓動看看效果。
新建API接口
接下來,我們要編寫Web API。假設我們的Web工程負責處理商家的產品(Product)。我們需要提供根據product id返回product信息的get接口和更新product信息的put接口。首先我們定義Product類,該類包括產品id,產品名稱name以及價格price:
public class Product implements Serializable {
private static final long serialVersionUID = 1435515995276255188L;
private long id;
private String name;
private long price;
// getters setters
}
然後我們需要定義Controller類。由於Spring Boot內部使用Spring MVC作爲它的Web組件,所以我們可以通過註解的方式快速開發我們的接口類:
@RestController
@RequestMapping("/product")
public class ProductController {
@GetMapping("/{id}")
public Product getProductInfo(
@PathVariable("id")
Long productId) {
// TODO
return null;
}
@PutMapping("/{id}")
public Product updateProductInfo(
@PathVariable("id")
Long productId,
@RequestBody
Product newProduct) {
// TODO
return null;
}
}
我們簡單介紹一下上述代碼中所用到的註解的作用:
- @RestController:表示該類爲Controller,並且提供Rest接口,即所有接口的值以Json格式返回。該註解其實是@Controller和@ResponseBody的組合註解,便於我們開發Rest API。
- @RequestMapping、@GetMapping、@PutMapping:表示接口的URL地址。標註在類上的@RequestMapping註解表示該類下的所有接口的URL都以/product開頭。@GetMapping表示這是一個Get HTTP接口,@PutMapping表示這是一個Put HTTP接口。
- @PathVariable、@RequestBody:表示參數的映射關係。假設有個Get請求訪問的是/product/123,那麼該請求會由getProductInfo方法處理,其中URL裏的123會被映射到productId中。同理,如果是Put請求的話,請求的body會被映射到newProduct對象中。
這裏我們只定義了接口,實際的處理邏輯還未完成,因爲product的信息都存在數據庫中。接下來我們將在項目中集成mybatis,並且與數據庫做交互。
集成Mybatis
配置數據源
首先我們需要在配置文件中配置我們的數據源。我們採用mysql作爲我們的數據庫。這裏我們採用yaml作爲我們配置文件的格式。我們在resources目錄下新建application.yml文件:
spring:
# 數據庫配置
datasource:
url: jdbc:mysql://{your_host}/{your_db}
username: {your_username}
password: {your_password}
driver-class-name: org.gjt.mm.mysql.Driver
由於Spring Boot擁有自動配置的特性,我們不用新建一個DataSource的配置類,Sping Boot會自動加載配置文件並且根據配置文件的信息建立數據庫的連接池,十分便捷。
筆者推薦大家採用yaml作爲配置文件的格式。xml顯得冗長,properties沒有層級結構,yaml剛好彌補了這兩者的缺點。這也是Spring Boot默認就支持yaml格式的原因。
配置Mybatis
我們已經通過Spring Initializer在pom.xml中引入了mybatis-spring-boot-starte庫,該庫會自動幫我們初始化mybatis。首先我們在application.yml中填寫mybatis的相關配置:
# mybatis配置
mybatis:
# 配置映射類所在包名
type-aliases-package: com.wooyoo.learning.dao.domain
# 配置mapper xml文件所在路徑,這裏是一個數組
mapper-locations:
- mappers/ProductMapper.xml
然後,再在代碼中定義ProductMapper類:
@Mapper
public interface ProductMapper {
Product select(
@Param("id")
long id);
void update(Product product);
}
這裏,只要我們加上了@Mapper註解,Spring Boot在初始化mybatis時會自動加載該mapper類。
Spring Boot之所以這麼流行,最大的原因是它自動配置的特性。開發者只需要關注組件的配置(比如數據庫的連接信息),而無需關心如何初始化各個組件,這使得我們可以集中精力專注於業務的實現,簡化開發流程。
訪問數據庫
完成了Mybatis的配置之後,我們就可以在我們的接口中訪問數據庫了。我們在ProductController下通過@Autowired引入mapper類,並且調用對應的方法實現對product的查詢和更新操作,這裏我們以查詢接口爲例:
@RestController
@RequestMapping("/product")
public class ProductController {
@Autowired
private ProductMapper productMapper;
@GetMapping("/{id}")
public Product getProductInfo(
@PathVariable("id")
Long productId) {
return productMapper.select(productId);
}
// 避免篇幅過長,省略updateProductInfo的代碼
}
然後在你的mysql中插入幾條product的信息,就可以運行該項目看看是否能夠查詢成功了。
至此,我們已經成功地在項目中集成了Mybatis,增添了與數據庫交互的能力。但是這還不夠,一個現代化的Web項目,肯定會上緩存加速我們的數據庫查詢。接下來,將介紹如何科學地將Redis集成到Mybatis的二級緩存中,實現數據庫查詢的自動緩存。
集成Redis
配置Redis
同訪問數據庫一樣,我們需要配置Redis的連接信息。在application.yml文件中增加如下配置:
spring:
redis:
# redis數據庫索引(默認爲0),我們使用索引爲3的數據庫,避免和其他數據庫衝突
database: 3
# redis服務器地址(默認爲localhost)
host: localhost
# redis端口(默認爲6379)
port: 6379
# redis訪問密碼(默認爲空)
password:
# redis連接超時時間(單位爲毫秒)
timeout: 0
# redis連接池配置
pool:
# 最大可用連接數(默認爲8,負數表示無限)
max-active: 8
# 最大空閒連接數(默認爲8,負數表示無限)
max-idle: 8
# 最小空閒連接數(默認爲0,該值只有爲正數纔有作用)
min-idle: 0
# 從連接池中獲取連接最大等待時間(默認爲-1,單位爲毫秒,負數表示無限)
max-wait: -1
上述列出的都爲常用配置,讀者可以通過註釋信息瞭解每個配置項的具體作用。由於我們在pom.xml中已經引入了spring-boot-starter-data-redis庫,所以Spring Boot會幫我們自動加載Redis的連接,具體的配置類org.springframework.boot.autoconfigure.data.redis.RedisAutoConfiguration。通過該配置類,我們可以發現底層默認使用Jedis庫,並且提供了開箱即用的redisTemplate和stringTemplate。
將Redis作爲二級緩存
Mybatis的二級緩存原理本文不再贅述,讀者只要知道,Mybatis的二級緩存可以自動地對數據庫的查詢做緩存,並且可以在更新數據時同時自動地更新緩存。
實現Mybatis的二級緩存很簡單,只需要新建一個類實現org.apache.ibatis.cache.Cache接口即可。
該接口共有以下五個方法:
- String getId():mybatis緩存操作對象的標識符。一個mapper對應一個mybatis的緩存操作對象。
- void putObject(Object key, Object value):將查詢結果塞入緩存。
- Object getObject(Object key):從緩存中獲取被緩存的查詢結果。
- Object removeObject(Object key):從緩存中刪除對應的key、value。只有在回滾時觸發。一般我們也可以不用實現,具體使用方式請參考:org.apache.ibatis.cache.decorators.TransactionalCache。
- void clear():發生更新時,清除緩存。
- int getSize():可選實現。返回緩存的數量。
- ReadWriteLock getReadWriteLock():可選實現。用於實現原子性的緩存操作。
接下來,我們新建RedisCache類,實現Cache接口:
public class RedisCache implements Cache {
private static final Logger logger = LoggerFactory.getLogger(RedisCache.class);
private final ReadWriteLock readWriteLock = new ReentrantReadWriteLock();
private final String id; // cache instance id
private RedisTemplate redisTemplate;
private static final long EXPIRE_TIME_IN_MINUTES = 30; // redis過期時間
public RedisCache(String id) {
if (id == null) {
throw new IllegalArgumentException("Cache instances require an ID");
}
this.id = id;
}
@Override
public String getId() {
return id;
}
/**
* Put query result to redis
*
* @param key
* @param value
*/
@Override
@SuppressWarnings("unchecked")
public void putObject(Object key, Object value) {
RedisTemplate redisTemplate = getRedisTemplate();
ValueOperations opsForValue = redisTemplate.opsForValue();
opsForValue.set(key, value, EXPIRE_TIME_IN_MINUTES, TimeUnit.MINUTES);
logger.debug("Put query result to redis");
}
/**
* Get cached query result from redis
*
* @param key
* @return
*/
@Override
public Object getObject(Object key) {
RedisTemplate redisTemplate = getRedisTemplate();
ValueOperations opsForValue = redisTemplate.opsForValue();
logger.debug("Get cached query result from redis");
return opsForValue.get(key);
}
/**
* Remove cached query result from redis
*
* @param key
* @return
*/
@Override
@SuppressWarnings("unchecked")
public Object removeObject(Object key) {
RedisTemplate redisTemplate = getRedisTemplate();
redisTemplate.delete(key);
logger.debug("Remove cached query result from redis");
return null;
}
/**
* Clears this cache instance
*/
@Override
public void clear() {
RedisTemplate redisTemplate = getRedisTemplate();
redisTemplate.execute((RedisCallback) connection -> {
connection.flushDb();
return null;
});
logger.debug("Clear all the cached query result from redis");
}
@Override
public int getSize() {
return 0;
}
@Override
public ReadWriteLock getReadWriteLock() {
return readWriteLock;
}
private RedisTemplate getRedisTemplate() {
if (redisTemplate == null) {
redisTemplate = ApplicationContextHolder.getBean("redisTemplate");
}
return redisTemplate;
}
}
講解一下上述代碼中一些關鍵點:
- 自己實現的二級緩存,必須要有一個帶id的構造函數,否則會報錯。
- 我們使用Spring封裝的redisTemplate來操作Redis。網上所有介紹redis做二級緩存的文章都是直接用jedis庫,但是筆者認爲這樣不夠Spring Style,而且,redisTemplate封裝了底層的實現,未來如果我們不用jedis了,我們可以直接更換底層的庫,而不用修改上層的代碼。更方便的是,使用redisTemplate,我們不用關心redis連接的釋放問題,否則新手很容易忘記釋放連接而導致應用卡死。
- 需要注意的是,這裏不能通過autowire的方式引用redisTemplate,因爲RedisCache並不是Spring容器裏的bean。所以我們需要手動地去調用容器的getBean方法來拿到這個bean,具體的實現方式請參考Github中的代碼。
- 我們採用的redis序列化方式是默認的jdk序列化。所以數據庫的查詢對象(比如Product類)需要實現Serializable接口。
這樣,我們就實現了一個優雅的、科學的並且具有Spring Style的Redis緩存類。
開啓二級緩存
接下來,我們需要在ProductMapper.xml中開啓二級緩存:
/p>
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
SELECT * FROM products WHERE id = #{id} LIMIT 1
UPDATE products SET name = #{name}, price = #{price} WHERE id = #{id} LIMIT 1
測試
配置H2內存數據庫
至此我們已經完成了所有代碼的開發,接下來我們需要書寫單元測試代碼來測試我們代碼的質量。我們剛纔開發的過程中採用的是mysql數據庫,而一般我們在測試時經常採用的是內存數據庫。這裏我們使用H2作爲我們測試場景中使用的數據庫。
要使用H2也很簡單,只需要跟使用mysql時配置一下即可。在application.yml文件中:
---
spring:
profiles: test
# 數據庫配置
datasource:
url: jdbc:h2:mem:test
username: root
password: 123456
driver-class-name: org.h2.Driver
schema: classpath:schema.sql
data: classpath:data.sql
爲了避免和默認的配置衝突,我們用---另起一段,並且用profiles: test表明這是test環境下的配置。然後只要在我們的測試類中加上@ActiveProfiles(profiles = "test")註解來啓用test環境下的配置,這樣就能一鍵從mysql數據庫切換到h2數據庫。
在上述配置中,schema.sql用於存放我們的建表語句,data.sql用於存放insert的數據。這樣當我們測試時,h2就會讀取這兩個文件,初始化我們所需要的表結構以及數據,然後在測試結束時銷燬,不會對我們的mysql數據庫產生任何影響。這就是內存數據庫的好處。另外,別忘了在pom.xml中將h2的依賴的scope設置爲test。
使用Spring Boot就是這麼簡單,無需修改任何代碼,輕鬆完成數據庫在不同環境下的切換。
編寫測試代碼
因爲我們是通過Spring Initializer初始化的項目,所以已經有了一個測試類——SpringBootMybatisWithRedisApplicationTests。
Spring Boot提供了一些方便我們進行Web接口測試的工具類,比如TestRestTemplate。然後在配置文件中我們將log等級調成DEBUG,方便觀察調試日誌。具體的測試代碼如下:
@RunWith(SpringRunner.class)
@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT)
@ActiveProfiles(profiles = "test")
public class SpringBootMybatisWithRedisApplicationTests {
@LocalServerPort
private int port;
@Autowired
private TestRestTemplate restTemplate;
@Test
public void test() {
long productId = 1;
Product product = restTemplate.getForObject("http://localhost:" + port + "/product/" + productId, Product.class);
assertThat(product.getPrice()).isEqualTo(200);
Product newProduct = new Product();
long newPrice = new Random().nextLong();
newProduct.setName("new name");
newProduct.setPrice(newPrice);
restTemplate.put("http://localhost:" + port + "/product/" + productId, newProduct);
Product testProduct = restTemplate.getForObject("http://localhost:" + port + "/product/" + productId, Product.class);
assertThat(testProduct.getPrice()).isEqualTo(newPrice);
}
}
在上述測試代碼中:
- 我們首先調用get接口,通過assert語句判斷是否得到了預期的對象。此時該product對象會存入redis中。
- 然後我們調用put接口更新該product對象,此時redis緩存會失效。
- 最後我們再次調用get接口,判斷是否獲取到了新的product對象。如果獲取到老的對象,說明緩存失效的代碼執行失敗,代碼存在錯誤,反之則說明我們代碼是OK的。
書寫單元測試是一個良好的編程習慣。雖然會佔用你一定的時間,但是當你日後需要做一些重構工作時,你就會感激過去寫過單元測試的自己。
查看測試結果
我們在Intellij中點擊執行測試用例,測試結果如下:
真棒,顯示的是綠色,說明測試用例執行成功了。
總結
本篇文章介紹瞭如何通過Spring Boot、Mybatis以及Redis快速搭建一個現代化的Web項目,並且同時介紹瞭如何在Spring Boot下優雅地書寫單元測試來保證我們的代碼質量。當然這個項目還存在一個問題,那就是mybatis的二級緩存只能通過flush整個DB來實現緩存失效,這個時候可能會把一些不需要失效的緩存也給失效了,所以具有一定的侷限性。
希望通過本篇文章,能夠給讀者帶來一些收穫和啓發。有任何的意見或者建議請在本文下方評論。謝謝大家的閱讀
原文:https://juejin.im/post/592c08292f301e006c60cae2