本文主要是項目開發(fā)過程中常用功能的總結。
下文我提到的部分功能都可以結合Hutool來實現(xiàn)。所以先來了解一下Hutool文檔：https://www.hutool.club/docs/#/
一 發(fā)送郵件
1 引入依賴
我們可以使用Hutool的MailUtil來發(fā)送郵箱，需要加入Hutool和MailUtil的依賴。
// hutool依賴
<dependency>
<groupId>cn.hutool</groupId>
<artifactId>hutool-all</artifactId>
<version>5.0.3</version>
</dependency>
// 發(fā)送郵件依賴
<dependency>
<groupId>javax.mail</groupId>
<artifactId>mail</artifactId>
<version>1.4.7</version>
</dependency>
2 郵箱配置
要想實現(xiàn)發(fā)郵件功能，就得配置發(fā)件郵箱?，F(xiàn)在我以qq郵箱和騰訊企業(yè)郵箱為例說明。
-
qq郵箱
登錄郵箱，依次點擊設置-->賬戶-->POP3/IMAP/SMTP/Exchange/CardDAV/CalDAV服務,看到如下界面：
默認情況下，POP3/SMTP服務是關閉的，我們需要開啟它，按照提示，我們最終可以得到授權碼，這個我們后面需要用到。 騰訊企業(yè)郵箱
企業(yè)郵箱不需要授權碼。
3 功能實現(xiàn)
在classpath（在標準Maven項目中為src/main/resources）目錄或在classpath的config目錄下新建mail.setting文件。
mail.setting之所以要放到上述目錄下，是Hutool源碼中所規(guī)定的。
#收件人郵箱
to = xxx
# 騰訊企業(yè)郵箱配置
# 郵件服務器的SMTP地址
host = smtp.exmail.qq.com
# 郵件服務器的SMTP端口
port = 465
# 發(fā)件人郵箱（必須正確，否則發(fā)送失?。? from = xxx
# 用戶名，默認為發(fā)件人郵箱前綴，我填的與from一致
user = xxx
# 授權碼
pass = 上一步郵箱配置里獲得的授權碼（QQ郵箱）或密碼（騰訊企業(yè)郵箱）
# 在使用QQ或Gmail郵箱時，需要強制開啟SSL支持
sslEnable = true
#qq郵箱配置
# host = smtp.qq.com
# 郵件服務器的SMTP端口
# port = 465
# 發(fā)件人（必須正確，否則發(fā)送失敗）
# from = xxx@qq.com
# 用戶名，默認為發(fā)件人郵箱前綴
# user = xxx@qq.com
# 授權碼
# pass = 上一步郵箱配置里獲得的授權碼
# 在使用QQ或Gmail郵箱時，需要強制開啟SSL支持
sslEnable = true
配置完成后，就可以使用Hutool的發(fā)送郵件功能了。
//讀取classpath下的mail.setting
Setting setting = new Setting("mail.setting");
//獲取收件人
String to = setting.getStr("to");
MailUtil.send(to, "測試", “測試內(nèi)容”, true);
以上只是發(fā)送了普通文本郵件，參照官方文檔，你也可以實現(xiàn)發(fā)送HTML格式的郵件并附帶附件以及群發(fā)的功能。
下面我們來看看'mail.setting'配置文件如何調(diào)用的，進入MailUtil.send源碼，最終可以看到：
MailUtil.java
可以看到第一行
Mail.create構造了一個mail對象，構造方法如下：
Mail.java
我們可以看出也可以通過傳入MailAccount的方式傳入配置。這在官方文檔中也給出了相應示例。如果用戶沒有傳入一個mailAccount，系統(tǒng)會從GlobalMailAccount中取。
GlobalMailAccount.java
而系統(tǒng)取得mailAccount的路徑是以下三個：
MailAccount.java
說明我們的
mail.setting按照以上三種方式放都是可以的。
二 生成二維碼
現(xiàn)在需要生成類似下圖的二維碼圖片，包括背景圖片（背景圖片來源），二維碼和文字。
效果圖
- 生成二維碼是第一步
Hutool的QrCodeUtil可以生成二維碼，引入依賴
<dependency>
<groupId>com.google.zxing</groupId>
<artifactId>core</artifactId>
<version>3.3.3</version>
</dependency>
- 生成二維碼，拼接背景圖片并添加文字
public static void main(String[] args) throws IOException {
QrConfig config = new QrConfig(400, 380);
// 高糾錯級別
config.setErrorCorrection(ErrorCorrectionLevel.H);
config.setMargin(1);
File output = new File("f:/test/output.jpg");
//生成二維碼
File file = QrCodeUtil.generate("http://192.168.168.132:9528/faq", config, output);
//合并背景圖片和二維碼
if (file.exists()) {
BufferedImage bi1 = null;
BufferedImage bi2 = null;
BufferedImage destImg = null;
//讀取背景圖片
File background = new File("f:/test/background.png");
//讀取二維碼圖片
bi1 = ImageIO.read(background);
//讀取背景圖片
bi2 = ImageIO.read(file);
destImg = PictureMerge.mergeImage(bi1, bi2, true, 110, 140);
//為圖片添加文字
destImg = PictureMerge.drawTextInImg(destImg, new FontText("ID : TI1911080001", "#333333", 30, "Arial"), 180, 530);
boolean result = PictureMerge.saveImage(destImg, "f:/test/","new.jpg", "jpg");
}
｝
- 圖片文字拼接工具類
/**
* 圖片合并工具類
*
* @author : TiaNa
* @createdDate : 2019/10/21
* @updatedDate
*/
public class PictureMerge {
/**
* @param fileUrl 文件絕對路徑或相對路徑
* @return 讀取到的緩存圖像
* @throws IOException 路徑錯誤或者不存在該文件時拋出IO異常
*/
public static BufferedImage getBufferedImage(String fileUrl) throws IOException {
File f = new File(fileUrl);
return ImageIO.read(f);
}
/**
* @param savedImg 待保存的圖像
* @param saveDir 保存的目錄
* @param fileName 保存的文件名，必須帶后綴，比如 "beauty.jpg"
* @param format 文件格式：jpg、png或者bmp
* @return
*/
public static boolean saveImage(BufferedImage savedImg, String saveDir, String fileName, String format) {
boolean flag = false;
// 先檢查保存的圖片格式是否正確
String[] legalFormats = {"jpg", "JPG", "png", "PNG", "bmp", "BMP"};
int i = 0;
for (i = 0; i < legalFormats.length; i++) {
if (format.equals(legalFormats[i])) {
break;
}
}
if (i == legalFormats.length) { // 圖片格式不支持
System.out.println("不是保存所支持的圖片格式!");
return false;
}
// 再檢查文件后綴和保存的格式是否一致
String postfix = fileName.substring(fileName.lastIndexOf('.') + 1);
if (!postfix.equalsIgnoreCase(format)) {
System.out.println("待保存文件后綴和保存的格式不一致!");
return false;
}
String fileUrl = saveDir + fileName;
File file = new File(fileUrl);
try {
flag = ImageIO.write(savedImg, format, file);
} catch (IOException e) {
e.printStackTrace();
}
return flag;
}
/**
* 待合并的兩張圖必須滿足這樣的前提，如果水平方向合并，則高度必須相等；如果是垂直方向合并，寬度必須相等。
* mergeImage方法不做判斷，自己判斷。
*
* @param img1 待合并的第一張圖
* @param img2 帶合并的第二張圖
* @param isHorizontal 為true時表示水平方向合并，為false時表示垂直方向合并
* @return 返回合并后的BufferedImage對象
* @throws IOException
*/
public static BufferedImage mergeImage(BufferedImage img1, BufferedImage img2, boolean isHorizontal, int startX, int startY) throws IOException {
int w1 = img1.getWidth();
int h1 = img1.getHeight();
int w2 = img2.getWidth();
int h2 = img2.getHeight();
// 從圖片中讀取RGB
int[] ImageArrayOne = new int[w1 * h1];
ImageArrayOne = img1.getRGB(0, 0, w1, h1, ImageArrayOne, 0, w1); // 逐行掃描圖像中各個像素的RGB到數(shù)組中
int[] ImageArrayTwo = new int[w2 * h2];
ImageArrayTwo = img2.getRGB(0, 0, w2, h2, ImageArrayTwo, 0, w2);
// 生成新圖片
BufferedImage DestImage = null;
if (isHorizontal) { // 水平方向合并
DestImage = new BufferedImage(w1, h1, BufferedImage.TYPE_INT_RGB);
DestImage.setRGB(0, 0, w1, h1, ImageArrayOne, 0, w1); // 設置上半部分或左半部分的RGB
DestImage.setRGB(startX, startY, w2, h2, ImageArrayTwo, 0, w2); // 設置下半部分的RGB
} else { // 垂直方向合并
DestImage = new BufferedImage(w1, h1 + h2, BufferedImage.TYPE_INT_RGB);
DestImage.setRGB(0, 0, w1, h1, ImageArrayOne, 0, w1); // 設置上半部分或左半部分的RGB
DestImage.setRGB(0, h1, w2, h2, ImageArrayTwo, 0, w2); // 設置下半部分的RGB
}
return DestImage;
}
/**
* <p>Title: getImageStream</p>
* <p>Description: 獲取圖片InputStream</p>
*
* @param destImg
* @return
*/
public static InputStream getImageStream(BufferedImage destImg) {
InputStream is = null;
BufferedImage bi = destImg;
ByteArrayOutputStream bs = new ByteArrayOutputStream();
ImageOutputStream imOut;
try {
imOut = ImageIO.createImageOutputStream(bs);
ImageIO.write(bi, "png", imOut);
is = new ByteArrayInputStream(bs.toByteArray());
} catch (IOException e) {
e.printStackTrace();
}
return is;
}
/**
* Description: 圖片上添加文字業(yè)務需求要在圖片上添加文字
*
* @param bimage
* @param text
* @param left
*/
public static BufferedImage drawTextInImg(BufferedImage bimage, FontText text, int left, int top) {
Graphics2D g = bimage.createGraphics();
g.setColor(getColor(text.getColor()));
g.setBackground(Color.white);
Font font = new Font(text.getFont(), Font.BOLD,
text.getSize());
g.setFont(font);
g.drawString(text.getText(), left, top);
g.dispose();
return bimage;
}
// color #2395439
public static Color getColor(String color) {
if (color.charAt(0) == '#') {
color = color.substring(1);
}
if (color.length() != 6) {
return null;
}
try {
int r = Integer.parseInt(color.substring(0, 2), 16);
int g = Integer.parseInt(color.substring(2, 4), 16);
int b = Integer.parseInt(color.substring(4), 16);
return new Color(r, g, b);
} catch (NumberFormatException nfe) {
return null;
}
}
- 字體類
/**
* 字體
*
* @author : TiaNa
* @createdDate : 2019/10/21
* @updatedDate
*/
@Data
public class FontText {
private String text;
private String color;
private Integer size;
private String font;
public FontText(String text, String color,
Integer size, String font) {
super();
this.text = text;
this.color = color;
this.size = size;
this.font = font;
}
public FontText() {
}
}
三 excel表格導入導出
- 這里也是使用的Hutool工具實現(xiàn)
@Slf4j
public class ExcelUtils {
/**
* 讀取excel表格內(nèi)容返回List<Bean>
*
* @param inputStream excel文件流
* @param head 表頭數(shù)組
* @param headerAlias 表頭別名數(shù)組
* @param bean 返回的Bean對象
* @return
*/
public static <T> List<T> importExcel(InputStream inputStream, String[] head, String[] headerAlias, Class<T> bean) {
ExcelReader reader = ExcelUtil.getReader(inputStream);
List<Object> header = reader.readRow(1);
//替換表頭關鍵字
if (ArrayUtils.isEmpty(head) || ArrayUtils.isEmpty(headerAlias) || head.length != headerAlias.length) {
log.error("導入的excel表，表頭格式與設定規(guī)則不一致");
} else {
for (int i = 0; i < head.length; i++) {
if (head[i].equals(header.get(i))) {
reader.addHeaderAlias(head[i], headerAlias[i]);
} else {
log.error("導入的excel表，表頭格式與設定規(guī)則不一致");
}
}
}
//讀取指點行開始的表數(shù)據(jù)（以下介紹的三個參數(shù)也可以使用動態(tài)傳入，根據(jù)個人業(yè)務情況修改）
//1：表頭所在行數(shù) 2：數(shù)據(jù)開始讀取位置 3：映射返回的Bean對象
List<T> read = reader.read(1, 2, bean);
return read;
}
/**
* 導出excel表格內(nèi)容
*
* @param filename 文件名
* @param head 表頭數(shù)組
* @param headerAlias 表頭別名數(shù)組
* @param list 導入的數(shù)據(jù)
* @return
*/
public static void exportExcel(String filename, String[] head, String[] headerAlias, List list) {
ExcelWriter writer = ExcelUtil.getWriter(filename);
List rows = CollUtil.newArrayList(list);
if (ArrayUtils.isEmpty(head) || ArrayUtils.isEmpty(headerAlias) || head.length != headerAlias.length) {
log.error("導入的excel表，表頭屬性與設定規(guī)則不一致");
} else {
for (int i = 0; i < head.length; i++) {
writer.addHeaderAlias(head[i], headerAlias[i]);
}
}
// 一次性寫出內(nèi)容，使用默認樣式，強制輸出標題
writer.write(rows, true);
// 關閉writer，釋放內(nèi)存
writer.close();
}
}
- 測試
@RunWith(SpringRunner.class)
@SpringBootTest
public class ExcelTest {
@Autowired
private InstallService installService;
@Test
public void exportExcel(){
List<DeviceInstall> list = installService.list();
String name = "測試單-" + LocalDateTime.now().format(DateTimeFormatter.ofPattern("yyyyMMdd-HHmmss"));
//list里實體字段要和excelHead 保持一致
String[] excelHeadAlias = {"編號", "日期", "聯(lián)系人", "聯(lián)系人電話", "描述"};
String[] excelHead = {"Id", "installUserPhone", "installLinkUser", "installLinkPhone", "installNotes"};
ExcelUtils.exportExcel("F:/test/excel/".concat(name).concat(".xlsx"), excelHead, excelHeadAlias, list);
}
四 Redis緩存用戶登錄信息，并實現(xiàn)token驗證
?系統(tǒng)中需要緩存用戶登錄信息和驗證碼，在此之前我使用session緩存，在單服務器中這樣也沒太大問題，但當服務部署到集群環(huán)境，就會出現(xiàn)session不一致的問題，這里是# 分布式系統(tǒng)session一致性的問題，我最終的解決方案就是用Redis緩存用戶信息。
1 實現(xiàn)思路：
- 用戶登錄時，校驗成功后，產(chǎn)生uuid，以uuid為key，用戶信息為value存入Redis，過期時長為15分鐘。此外，我還需要將uuid傳給前端。
- 用戶調(diào)用其他接口時，請求頭中需加入登錄時返回的uuid值，后端攔截器攔截到到有效的uuid時，要相對應的給Redis中的uuid續(xù)命，延長過期時間。
2 實現(xiàn)過程：
首先需要學習Redis基礎，如果對Springboot整合Redis不熟悉，可以參考文章：idea整合springboot+redis,下面我們看代碼
- 用戶登錄實現(xiàn)類
@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements UserService {
@Autowired
private RedisUtils redisUtils;
@Override
public UserVO login(String account, String pwd, HttpSession session) {
//根據(jù)用戶賬戶查詢用戶信息
LambdaQueryWrapper<User> query = Wrappers.lambdaQuery();
query.eq(User::getAccount, account);
User user = getOne(query);
if (user != null && pwd.equals(user.getPassword())) {
//登錄信息存儲在redis中
String uuid = UUID.randomUUID().toString();
user.setToken(uuid);
redisUtils.set(uuid, user, 900);
return user;
}
}
throw new MyException("用戶名或密碼錯誤");
}
- 攔截器,值得注意的是，攔截器中要放行OPTIONS請求AJAX中OPTIONS請求和GET請求
public class UserInterceptor implements HandlerInterceptor {
@Autowired
private RedisUtils redisUtils;
/**
* 在請求處理之前進行調(diào)用（Controller方法調(diào)用之前）
*/
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object object) throws IOException {
//獲取token
String token = request.getHeader("token");
//不攔截options請求
if ("OPTIONS".equalsIgnoreCase(request.getMethod())) {
return true;
}
//查詢redis存儲的用戶信息
if (!StringUtils.isBlank(token ) && redisUtils.exists(token )) {
//更新登錄有效時間
redisUtils.expire(redisUser, 900);
return true;
} else {
throw new DataValidationException("用戶身份信息錯誤");
}
}
/**
* 請求處理之后進行調(diào)用，但是在視圖被渲染之前（Controller方法調(diào)用之后）
*/
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object object, ModelAndView mv)
throws Exception {
}
/**
* 在整個請求結束之后被調(diào)用，也就是在DispatcherServlet 渲染了對應的視圖之后執(zhí)行 （主要是用于進行資源清理工作）
*/
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object object, Exception ex)
throws Exception {
}
public void returnErrorResponse(HttpServletResponse response, Result result)
throws IOException, UnsupportedEncodingException {
OutputStream out = null;
try {
response.setCharacterEncoding("utf-8");
response.setContentType("text/json");
out = response.getOutputStream();
out.write(JSONUtil.toJsonStr(result).getBytes("utf-8"));
out.flush();
} finally {
if (out != null) {
out.close();
}
}
}
}
- 攔截器配置，不攔截登錄請求和swagger文檔，且必須配置跨域
@Configuration
public class WebMvcConfig extends WebMvcConfigurationSupport {
@Bean
public UserInterceptor getUserInterceptor() {
return new UserInterceptor();
}
@Override
public void addInterceptors(InterceptorRegistry registry) {
/**
* 攔截器按照順序執(zhí)行
*/
registry.addInterceptor(getUserInterceptor())
.excludePathPatterns("/api/v010/users/login")
.excludePathPatterns("/swagger-resources/**", "/webjars/**", "/v2/**", "/swagger-ui.html/**");
}
@Override
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
registry.addResourceHandler("swagger-ui.html")
.addResourceLocations("classpath:/META-INF/resources/");
registry.addResourceHandler("/webjars/**")
.addResourceLocations("classpath:/META-INF/resources/webjars/");
}
//支持跨域請求
@Override
public void addCorsMappings(CorsRegistry registry) {
registry.addMapping("/**")
.allowedOrigins("*")
.allowCredentials(true)
.allowedMethods("GET", "POST", "DELETE", "PUT")
.maxAge(3600);
super.addCorsMappings(registry);
}
}
3 測試：
- 訪問登錄接口http://localhost:8080/users/login，獲取uuid
登錄接口返回數(shù)據(jù) -
訪問其他接口時,請求頭加上uuid就能請求成功，否則拋出異常
header
五 全局異常處理
這里寫的非常詳細了：# SpringBoot 全局異常處理詳解
六 權限管理
在所有系統(tǒng)中，都有權限管理的功能，下面這篇文章可以提供很多思路
一個基于SpringBoot2+Shiro的權限管理系統(tǒng)
