給大家聊一聊雲收藏從 Spring Boot 1.0 升級到 2.0 所踩的坑
先給大家曬一下雲收藏的幾個資料,作為一個 Spring Boot 的開源專案(https://github.com/cloudfavorites/favorites-web)目前在 Github 上面已經有1600多個 Star,如果按照 SpringBoot 標籤進行篩選的話也可以排到第五位。
當雲收藏1.0開發完成之後,同步將雲收藏部署到了伺服器上,申請了一個域名www.favorites.ren方便大家使用,到目前為止:網站的註冊使用者4000多人,共計收藏文章100000多條,在百度上搜尋:雲收藏,排在第一的就是雲收藏的官網。2年多的時間這個資料其實也並不是很耀眼,但是作為一個學習 Spring Boot 的開源軟體來講,已經不錯了。
雲收藏的部署之路也挺曲折,剛開始的時候部署在我以前公司的伺服器上,後來離職的時候在阿里雲買了個1核1G的雲伺服器,因為安裝了 Mysql、Redis、還有其它小軟體導致伺服器非常卡,那段時間訪問雲收藏的時候需要等待2-3秒才會有響應。
終於有一天自己也不能忍了,花錢把伺服器升級到2核2G,訪問速度雖有所提升但還是很不理想,那段時間工作很忙也沒時間優化。網站的 Bug 也是一片,有時候還會突然中斷服務幾個小時,流失了一大批使用者,甚至有人在 Github 上面留言說:看來微笑哥已經放棄雲收藏了,我看了之後只能苦笑。
到了今年 Spring Boot 2.0 釋出的時候,我就計劃著把雲收藏全面升級到2.0,順便做一些優化讓訪問速度快一點。但一拖就是2個月,終於在前幾個週末抽出了一點時間,將雲收藏升級到了 Spring Boot 2.0 同時修復了一批顯而易見的 Bug ,使用 Nginx 將靜態圖片等資源做了代理,當這些工作完全做完的時候,雲收藏的訪問速度明顯得到了提升,大家可以訪問www.favorites.ren體驗一下。
將雲收藏從 Spring Boot 1.0 升級到 2.0 的時候也遇到了一些問題,在修改的過程中記錄下來,今天整理一下分享出來,方便後續升級的朋友少踩一些坑。
1、第一個問題:啟動類報錯
Spring Boot 部署到 Tomcat 中去啟動時需要在啟動類新增SpringBootServletInitializer
,2.0 和 1.0 有區別。
// 1.0
import org.springframework.boot.web.support.SpringBootServletInitializer;
// 2.0
import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;
@SpringBootApplication
public class UserManageApplication extends SpringBootServletInitializer {
@Override
protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
return application.sources(UserManageApplication.class);
}
public static void main(String[] args) throws Exception {
SpringApplication.run(UserManageApplication.class, args);
}
}
這個問題好解決只需要重新導包就行。
2、日誌類報錯:Spring Boot 2.0 預設不包含 log4j,建議使用 slf4j 。
import org.apache.log4j.Logger;
protected Logger logger = Logger.getLogger(this.getClass());
改為:
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
protected Logger logger = LoggerFactory.getLogger(this.getClass());
這個也比較好改動,就是需要替換的檔案比較多。
3、Spring Boot 2.0 去掉了findOne()
方法。
以前的findOne()
方法其實就是根據傳入的 Id 來查詢物件,所以在 Spring Boot 2.0 的 Repository 中我們可以新增findById(long id)
來替換使用。
例如:
User user=userRepository.findOne(Long id)
改為手動在userRepository
手動新增findById(long id)
方法,使用時將findOne()
呼叫改為findById(long id)
User user=userRepository.findById(long id)
delete()
方法和findOne()
類似也被去掉了,可以使用deleteById(Long id)
來替換,還有一個不同點是deleteById(Long id)
預設實現返回值為void
。
Long deleteById(Long id);
改為
//delete 改為 void 型別
void deleteById(Long id);
當然我們還有一種方案可以解決上述的兩種變化,就是自定義 Sql,但是沒有上述方案簡單不建議使用。
@Query("select t from Tag t where t.tagId = :tagId")
Tag getByTagId(@Param("tagId") long tagId);
4、雲收藏升級到 2.0 之後,插入資料會報錯,錯誤資訊如下:
org.springframework.dao.DataIntegrityViolationException: could not execute statement; SQL [n/a]; constraint [PRIMARY]; nested exception is org.hibernate.exception.ConstraintViolationException: could not execute statement
....
Caused by: org.hibernate.exception.ConstraintViolationException: could not execute statement
...
Caused by: com.mysql.jdbc.exceptions.jdbc4.MySQLIntegrityConstraintViolationException: Duplicate entry '299' for key 'PRIMARY'
這個問題稍稍花費了一點時間,報錯提示的是主鍵衝突,跟蹤資料庫的資料發現並沒有主鍵衝突,最後才發現是 Spring Boot 2.0 需要指定主鍵的自增策略,這個和 Spring Boot 1.0 有所區別,1.0 會使用預設的策略。
@Id
@GeneratedValue(strategy= GenerationType.IDENTITY)
private long id;
改動也比較簡單,需要在所有的主鍵上面顯示的指明自增策略。
5、Thymeleaf 3.0 預設不包含佈局模組。
這個問題比較尷尬,當我將 Pom 包升級到 2.0 之後,訪問首頁的時候一片空白什麼都沒有,檢視後臺也沒有任何的報錯資訊,首先嚐試著跟蹤了 http 請求,對比了一下也沒有發現什麼異常,在查詢 Thymeleaf 3.0 變化時才發現:Spring Boot 2.0 中spring-boot-starter-thymeleaf
包預設並不包含佈局模組,需要使用的時候單獨新增,新增布局模組如下:
<dependency>
<groupId>nz.net.ultraq.thymeleaf</groupId>
<artifactId>thymeleaf-layout-dialect</artifactId>
</dependency>
改完之後再訪問首頁,一切正常,但是回頭檢視日誌資訊發現有一個告警資訊:
2018-05-10 10:47:00.029 WARN 1536 --- [nio-8080-exec-2] n.n.u.t.decorators.DecoratorProcessor : The layout:decorator/data-layout-decorator processor has been deprecated and will be removed in the next major version of the layout dialect. Please use layout:decorate/data-layout-decorate instead to future-proof your code. See https://github.com/ultraq/thymeleaf-layout-dialect/issues/95 for more information.
2018-05-10 10:47:00.154 WARN 1536 --- [nio-8080-exec-2] n.n.u.t.expressions.ExpressionProcessor : Fragment expression "layout" is being wrapped as a Thymeleaf 3 fragment expression (~{...}) for backwards compatibility purposes. This wrapping will be dropped in the next major version of the expression processor, so please rewrite as a Thymeleaf 3 fragment expression to future-proof your code. See https://github.com/thymeleaf/thymeleaf/issues/451 for more information.
跟蹤地址看了一下,大概的意思是以前佈局的標籤已經過期了,推薦使用新的標籤來進行頁面佈局,解決方式也比較簡單,修改以前的佈局標籤 layout:decorator
為 layout:decorate
即可。
6、分頁元件PageRequest
變化。
在 Spring Boot 2.0 中 ,方法new PageRequest(page, size, sort)
已經過期不再推薦使用,推薦使用以下方式來構建分頁資訊:
Pageable pageable =PageRequest.of(page, size, Sort.by(Sort.Direction.ASC,"id"));
跟蹤了一下原始碼發現PageRequest.of()
方法,內部還是使用的new PageRequest(page, size, sort)
,只是最新的寫法更簡潔一些。
public static PageRequest of(int page, int size, Sort sort) {
return new PageRequest(page, size, sort);
}
7、關聯查詢時候組合返回物件的預設值有變化。
在使用 Spring Boot 1.0 時,使用 Jpa 關聯查詢時我們會構建一個介面物件來接收結果集,類似如下:
public interface CollectView{
Long getId();
Long getUserId();
String getProfilePicture();
String getTitle();
}
在使用 Spring Boot 1.0 時,如果沒有查詢到對應的欄位會返回空,在 Spring Boot 2.0 中會直接報空指標異常,對結果集的檢查會更加嚴格一些。
8、其它優化
前段時間在學習 Docker ,給雲收藏新增了 Docker 、Docker Compose 支援讓部署的時候更簡單一些;同時修復了一些 bug,對於明顯很消耗資源的功能進行了改進,部分功能新增了容錯性;本次部署的時候使用了 Nginx 作為反向代理,因為使用了 WebJars 暫時不能使用 Nginx 代理 Js,所以將除過 Js 以外的其它資源都配置了快取,;資料庫由 Mysql 換成了 Mariadb。
以上就是雲收藏從 Spring Boot 1.0 到 2.0 所做的一些小改進,做完這些工作之後驚喜的發現雲收藏的訪問速度比以前快了很多,雖然還有很大的優化空間,但日常使用基本上不會體驗到太大的延遲。Spring Boot 2.0 中 Thymeleaf 預設使用了 3.0 ,資料庫連線池預設使用了 Hikari ,這兩個元件在效能上有很大的提升,同時也是提升雲收藏訪問速度的因素之一。
未來雲收藏還會持續升級,後續會規劃一些面向程式設計師的新功能,敬請期待!