瑞吉外卖总结笔记
环境
SpringBoot、Mybatis-Plus
注意:使用Mybatis-Plus时,属性值要与数据库中的列名一致
静态映射
当将使用SpringBoot整合前端html项目时,需要使用静态资源的映射,否则会出现html页面部分效果无法展示
解决
需要在WebMvcConfig配置类中进行静态资源映射
resource目录下的结构
@Slf4j
@Configuration
public class WebMvcConfig extends WebMvcConfigurationSupport {
@Override
protected void addResourceHandlers(ResourceHandlerRegistry registry) {
log.info("开始进行静态资源映射...");
registry.addResourceHandler("/backend/**").addResourceLocations("classpath:/backend/");
registry.addResourceHandler("/front/**").addResourceLocations("classpath:/front/");
}
}
服务器对long型数据不友好
前端服务器中对于long型数据只保留了前16位,根据id修改信息时,会出现信息没改动的结果
解决
1、提供对象转化器JacksonObjectMapper,基于jackson进行java对象到json数据的转换
2、在WebMvcConfig配置类中扩展SpringMVC的消息转换器,在此消息转换器中使用提供的对象转换器进行java对象到json数据的转换。
JacksonObjectMapper类:
package com.dc.reggie.config;
import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.module.SimpleModule;
import com.fasterxml.jackson.databind.ser.std.ToStringSerializer;
import com.fasterxml.jackson.datatype.jsr310.deser.LocalDateDeserializer;
import com.fasterxml.jackson.datatype.jsr310.deser.LocalDateTimeDeserializer;
import com.fasterxml.jackson.datatype.jsr310.deser.LocalTimeDeserializer;
import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateSerializer;
import com.fasterxml.jackson.datatype.jsr310.ser.LocalDateTimeSerializer;
import com.fasterxml.jackson.datatype.jsr310.ser.LocalTimeSerializer;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.LocalDateTime;
import java.time.LocalTime;
import java.time.format.DateTimeFormatter;
import static com.fasterxml.jackson.databind.DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES;
public class JacksonObjectMapper extends ObjectMapper {
public static final String DEFAULT_DATE_FORMAT = "yyyy-MM-dd";
public static final String DEFAULT_DATE_TIME_FORMAT = "yyyy-MM-dd HH:mm:ss";
public static final String DEFAULT_TIME_FORMAT = "HH:mm:ss";
public JacksonObjectMapper() {
super();
//收到未知属性时不报异常
this.configure(FAIL_ON_UNKNOWN_PROPERTIES, false);
//反序列化时,属性不存在的兼容处理
this.getDeserializationConfig().withoutFeatures(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES);
SimpleModule simpleModule = new SimpleModule()
.addDeserializer(LocalDateTime.class, new LocalDateTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT)))
.addDeserializer(LocalDate.class, new LocalDateDeserializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT)))
.addDeserializer(LocalTime.class, new LocalTimeDeserializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)))
.addSerializer(BigInteger.class, ToStringSerializer.instance)
.addSerializer(Long.class, ToStringSerializer.instance)
.addSerializer(LocalDateTime.class, new LocalDateTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_TIME_FORMAT)))
.addSerializer(LocalDate.class, new LocalDateSerializer(DateTimeFormatter.ofPattern(DEFAULT_DATE_FORMAT)))
.addSerializer(LocalTime.class, new LocalTimeSerializer(DateTimeFormatter.ofPattern(DEFAULT_TIME_FORMAT)));
//注册功能模块 例如,可以添加自定义序列化器和反序列化器
this.registerModule(simpleModule);
}
}
公共自动填充
Mybatis Plus公共字段自动填充,也就是在插入或更新时为指定字段赋予指定的值,好处是,统一对这些字段进行处理,避免了重复代码
实现步骤:
1、在实体类的属性上加上@TableField注解,指定自动填充的策略
2、按照框架要求编写元数据对象处理器,在此类中统一为公共字段赋值,此类需要实现MetaObjectHandler接口
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-nfw2y28s-1689596477223)(%E7%91%9E%E5%90%89%E5%A4%96%E5%8D%96%E6%80%BB%E7%BB%93.assets/202307050920506.png)]
注意:当设置createUser和updateUser为固定值时,在后面需要进行改造,改为动态获得当前登录用户的id
ThreadLocal:
补充:
客户端发送的每次Http请求对应的在服务端都会分配一个新的线程来处理,在处理过程中涉及到下面类中的方法都属于相同的一个线程:
- LoginCheckFilter的doFilter方法
- EmployeeController的update方法
- MyMetaObjectHandler的updateFill方法
可以在上面的三个方法中分别加入下面代码(获得当前线程的id)
long id = Thread.*currentThread*().getId();
*log*.info("线程id为:{}", id);
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-L4W9Pjx9-1689596477223)(%E7%91%9E%E5%90%89%E5%A4%96%E5%8D%96%E6%80%BB%E7%BB%93.assets/202307050920159.png)]
什么是ThreadLocal?
ThreadLocal
并不是一个Thread,而是Thread的局部变量
。当使用ThreadLcoal维护变量时,ThreadLocal为每个使用该变量的线程提供独立的变量副本,所以每个线程都可以独立的改变自己的副本,而不会影响其他线程所对应的副本。ThreadLocal为每个线程提供单独一份存储空间,具有线程隔音的效果
,只有在线程内才能获取到对应的值,线程外侧不能访问。
ThreadLocal常用的方法:
- public void set(T value) 设置当前线程的线程局部变量的值
- public T get() 返回当前线程所对应的线程局部变量的值
所以可以在LoginCheckFilter的doFilter方法中获取当前登录用户的id,并调用ThreadLocal的set方法来设置当前线程的线程局部变量的值(用户id),然后在MyMetaObjectHandler的updateFill方法中调用ThreadLocal的get方法来获得当前线程所对应的线程局部变量的值(用户id)
实现步骤:
- 编写BaseContext工具类,基于ThreadLcoal封装的工具类
- 在LoginCheckFilter的doFIlter方法中调用BaseContext来设置当前登录用户的id
- 在MyMetaObjectHandler的方法中调用BaseContext获取登录用户的id
BaseContext工具类:
package com.dc.reggie.commons;
/**
* 基于ThreadLocal封装工具类,用户保存和获取当前登录用户的id
*/
public class BaseContext {
private static ThreadLocal<Long> threadLocal = new ThreadLocal<Long>();
/**
* 设置值
* @param
* @return
*/
public static void setCurrentId(Long id){
threadLocal.set(id);
}
/**
* 获取值
* @param
* @return
*/
public static Long getCurrentId(){
return threadLocal.get();
}
}
MyMetaObjectHandler:
package com.dc.reggie.commons;
import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;
import java.time.LocalDateTime;
/**
* 自定义元数据对象处理器
*/
@Component
@Slf4j
public class MyMetaObjectHandler implements MetaObjectHandler {
/**
* 插入操作,自动填充
* @param
* @return
*/
@Override
public void insertFill(MetaObject metaObject) {
log.info("公共字段自动填充[insert]");
log.info(metaObject.toString());
metaObject.setValue("createTime", LocalDateTime.now());
metaObject.setValue("updateTime", LocalDateTime.now());
metaObject.setValue("createUser", BaseContext.getCurrentId());
metaObject.setValue("updateUser", BaseContext.getCurrentId());
}
/**
* 更新操作,自动填充
* @param
* @return
*/
@Override
public void updateFill(MetaObject metaObject) {
log.info("公共字段自动填充[update]");
log.info(metaObject.toString());
metaObject.setValue("updateTime", LocalDateTime.now());
metaObject.setValue("updateUser", BaseContext.getCurrentId());
}
}
这样就可以实现公共字段的插入和更新
文件上传下载(本地)
上传
介绍
文件上传,也称为upload,是指将本地图片、视频、音频等文件上传到服务器上,可以供其他用户浏览和下载的过程。文件上传在项目中应用非常广泛,发微博、发微信朋友圈都用到了文件上传功能
要求
文件上传时,对页面的form表单有如下要求:
- method=“post” 采用post方式提交数据
- enctype=“multipart/form-data” 采用multipart格式上传文件
- type=“file” 使用input的file控件上传
页面端可以使用ElementUI提供的上传组件:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>文件上传</title>
<!-- 引入样式 -->
<link rel="stylesheet" href="../../plugins/element-ui/index.css" />
<link rel="stylesheet" href="../../styles/common.css" />
<link rel="stylesheet" href="../../styles/page.css" />
</head>
<body>
<div class="addBrand-container" id="food-add-app">
<div class="container">
<el-upload class="avatar-uploader"
action="/common/upload"
:show-file-list="false"
:on-success="handleAvatarSuccess"
:before-upload="beforeUpload"
ref="upload">
<img v-if="imageUrl" :src="imageUrl" class="avatar"></img>
<i v-else class="el-icon-plus avatar-uploader-icon"></i>
</el-upload>
</div>
</div>
<!-- 开发环境版本,包含了有帮助的命令行警告 -->
<script src="../../plugins/vue/vue.js"></script>
<!-- 引入组件库 -->
<script src="../../plugins/element-ui/index.js"></script>
<!-- 引入axios -->
<script src="../../plugins/axios/axios.min.js"></script>
<script src="../../js/index.js"></script>
<script>
new Vue({
el: '#food-add-app',
data() {
return {
imageUrl: ''
}
},
methods: {
handleAvatarSuccess (response, file, fileList) {
this.imageUrl = `/common/download?name=${response.data}`
},
beforeUpload (file) {
if(file){
const suffix = file.name.split('.')[1]
const size = file.size / 1024 / 1024 < 2
if(['png','jpeg','jpg'].indexOf(suffix) < 0){
this.$message.error('上传图片只支持 png、jpeg、jpg 格式!')
this.$refs.upload.clearFiles()
return false
}
if(!size){
this.$message.error('上传文件大小不能超过 2MB!')
return false
}
return file
}
}
}
})
</script>
</body>
</html>
后端upload类:
package com.dc.reggie.controller;
import com.dc.reggie.commons.R;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;
import java.io.File;
import java.io.IOException;
import java.util.UUID;
@Slf4j
@RestController
@RequestMapping("/common")
public class CommonController {
@Value("${reggie.path}")
private String basePath;
/**
* 文件上传
* @param
* @return
*/
@PostMapping("/upload")
public R<String> upload(MultipartFile file){
// file是一个临时文件,需要转存到指定位置,否则本次请求完成后会被删除
log.info(file.toString());
// 原始文件名
String originalFilename = file.getOriginalFilename();
// 获取文件前缀
String suffix = originalFilename.substring(originalFilename.lastIndexOf("."));
// 使用UUID重新生成文件名,防止文件名称重复造成文件覆盖
String fileName = UUID.randomUUID().toString() + suffix;
// 创建一个目录对象
File dir = new File(basePath);
//判断当前目录是否存在
if (!dir.exists()){
// 目录不存在,需要创建
dir.mkdir();
}
try {
// 文件转存到磁盘中
file.transferTo(new File(basePath + fileName));
} catch (IOException e) {
throw new RuntimeException(e);
}
return R.success(fileName);
}
}
下载
文件下载,也成为download,是指文件从服务器传输到本地计算机的过程
通过浏览器进行文件下载,通常有两种表现形式:
- 以附件形式下载,弹出保存对话框,将文件保存到指定磁盘目录
- 直接在浏览器打开
通过浏览器进行文件下载,本质上就是服务器将文件已流的形式写回浏览器的过程
页面端可以使用<img>标签展示下载图片
<img v-if="imageUrl" :src="imageUrl" class="avatar"></img>
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-YafFqusV-1689596477224)(%E7%91%9E%E5%90%89%E5%A4%96%E5%8D%96%E6%80%BB%E7%BB%93.assets/202307051053486.png)]
代码:
/**
* 文件下载
* @param
* @return
*/
@GetMapping("/download")
public void download(String name, HttpServletResponse response){
try {
// 输出流,通过输入流读取文件内容
FileInputStream fileInputStream = new FileInputStream(new File(basePath + name));
// 输出流,通过输出流将文件写回浏览器,在浏览器展示图片
ServletOutputStream outputStream = response.getOutputStream();
response.setContentType("image/jpeg");
int len = 0;
byte[] bytes = new byte[1024];
while((len = fileInputStream.read(bytes)) != -1){
outputStream.write(bytes, 0, len);
outputStream.flush();
}
// 关闭资源
outputStream.close();
fileInputStream.close();
} catch (Exception e) {
throw new RuntimeException(e);
}
}
邮箱验证码发送
首先
使用邮箱发送需要先开启对应的邮箱POP3/IMAP或者/IMAP服务
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-YB1yKQjG-1689596477224)(%E7%91%9E%E5%90%89%E5%A4%96%E5%8D%96%E6%80%BB%E7%BB%93.assets/5736bdc114564a8893021a720ebd28ab.png)]
开启之后会返回一个密码,这个密码非常重要,不能泄露,有了这个密码可以进行第三方操作。
然后
导入maven依赖
<dependency>
<groupId>javax.mail</groupId>
<artifactId>javax.mail-api</artifactId>
<version>1.5.6</version>
</dependency>
<dependency>
<groupId>com.sun.mail</groupId>
<artifactId>javax.mail</artifactId>
<version>1.5.3</version>
</dependency>
然后导入发送工具类
发送邮件的工具类
package com.dc.reggie.commons;
import javax.mail.*;
import javax.mail.internet.InternetAddress;
import javax.mail.internet.MimeMessage;
import java.util.Properties;
/**
* 发送邮件
**/
public class MailUtils {
private static final String USER = "****@qq.com"; // 发件人称号,同邮箱地址
private static final String PASSWORD = "*****"; // 授权码,开启SMTP时显示
/**
*
* @param to 收件人邮箱
* @param text 邮件正文
* @param title 标题
*/
/* 发送验证信息的邮件 */
public static boolean sendMail(String to, String text, String title){
try {
final Properties props = new Properties();
props.put("mail.smtp.auth", "true");
// 注意发送邮件的方法中,发送给谁的,发送给对应的app,※
// 要改成对应的app。扣扣的改成qq的,网易的要改成网易的。※
// props.put("mail.smtp.host", "smtp.qq.com");
props.put("mail.smtp.host", "smtp.qq.com");
// 发件人的账号
props.put("mail.user", USER);
//发件人的密码
props.put("mail.password", PASSWORD);
// 构建授权信息,用于进行SMTP进行身份验证
Authenticator authenticator = new Authenticator() {
@Override
protected PasswordAuthentication getPasswordAuthentication() {
// 用户名、密码
String userName = props.getProperty("mail.user");
String password = props.getProperty("mail.password");
return new PasswordAuthentication(userName, password);
}
};
// 使用环境属性和授权信息,创建邮件会话
Session mailSession = Session.getInstance(props, authenticator);
// 创建邮件消息
MimeMessage message = new MimeMessage(mailSession);
// 设置发件人
String username = props.getProperty("mail.user");
InternetAddress form = new InternetAddress(username);
message.setFrom(form);
// 设置收件人
InternetAddress toAddress = new InternetAddress(to);
message.setRecipient(Message.RecipientType.TO, toAddress);
// 设置邮件标题
message.setSubject(title);
// 设置邮件的内容体
message.setContent(text, "text/html;charset=UTF-8");
// 发送邮件
Transport.send(message);
return true;
}catch (Exception e){
e.printStackTrace();
}
return false;
}
/* public static void main(String[] args) throws Exception { // 做测试用
String code = VerCodeGenerateUtil.generateVerCode();
MailUtils.sendMail("*****@qq.com","你好,测试验证码:" + code + ",无需回复。","测试邮件");//填写接收邮箱
System.out.println("发送成功");
}*/
}
生成验证码的工具类
package com.dc.reggie.commons;
import java.security.SecureRandom;
import java.util.Random;
/**
* 生成验证码
*/
public class VerCodeGenerateUtil {
/**
* 验证码包含的字段
*/
private static final String SYMBOLS = "0123456789ABCDEFGHIGKLMNOPQRSTUVWXYZ";
private static final Random RAND = new SecureRandom();
/**
* 生成 6 位数的随机数字
* @return {@link String 验证码}
*/
public static String generateVerCode(int n){
char[] code = new char[n];
for(int i = 0; i < code.length; i++) {
code[i] = SYMBOLS.charAt(RAND.nextInt(SYMBOLS.length()));
// RAND.nextInt(SYMBOLS.length()) 生成一个随机的索引值;
// RAND.nextInt(n) 生成一个0到n-1之间的随机整数;
}
return new String(code);
}
}
异常处理
全局异常处理
package com.dc.reggie.commons;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.bind.annotation.RestController;
import java.sql.SQLIntegrityConstraintViolationException;
@ControllerAdvice(annotations = {RestController.class, Controller.class})
@ResponseBody
@Slf4j
public class GlobalExceptionHandler {
/**
* 异常处理方法
* @param
* @return
*/
@ExceptionHandler(SQLIntegrityConstraintViolationException.class)
public R<String> exceptionHandler(SQLIntegrityConstraintViolationException e){
log.error(e.getMessage());
// 返回错误提示信息
if (e.getMessage().contains("Duplicate entry")){
String[] split = e.getMessage().split(" ");
String msg = split[2] + "已存在";
return R.error(msg);
}
return R.error("未知错误");
}
/**
*
* @param
* @return
*/
@ExceptionHandler(CustomException.class)
public R<String> exceptionHandler(CustomException e){
log.info(e.getMessage());
return R.error(e.getMessage());
}
}
自定义业务异常类
package com.itheima.reggie.common;
/**
* 自定义业务异常类
*/
public class CustomException extends RuntimeException {
public CustomException(String message){
super(message);
}
}
分页插件
package com.dc.reggie.config;
import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.PaginationInnerInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
/**
* 配置MP分页插件
*/
@Configuration
public class MybatisPlusConfig {
@Bean
public MybatisPlusInterceptor mybatisPlusInterceptor() {
MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor();
mybatisPlusInterceptor.addInnerInterceptor(new PaginationInnerInterceptor());
return mybatisPlusInterceptor;
}
}
过滤器类
package com.dc.reggie.filter;
import com.alibaba.fastjson.JSON;
import com.dc.reggie.commons.BaseContext;
import com.dc.reggie.commons.R;
import com.dc.reggie.entity.Employee;
import jakarta.servlet.*;
import jakarta.servlet.annotation.WebFilter;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import lombok.extern.slf4j.Slf4j;
import org.springframework.stereotype.Component;
import org.springframework.util.AntPathMatcher;
import java.io.IOException;
@Component
@Slf4j
@WebFilter(filterName = "loginCheckFilter", urlPatterns = "/*")
public class LoginCheckFilter implements Filter {
// 路径匹配器,支持通配符
public static final AntPathMatcher PATH_MATCHER = new AntPathMatcher();
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
HttpServletRequest request = (HttpServletRequest) servletRequest;
HttpServletResponse response = (HttpServletResponse) servletResponse;
// 1、获取本次请求的URI
String requestURI = request.getRequestURI();
log.info("拦截到请求:{}", requestURI);
String[] urls = new String[]{
"/employee/login",
"/employee/logout",
"/backend/**",
"/front/**",
"/common/**",
"/user/**"
};
// 判断本次请求是否需要处理
boolean check = check(urls, requestURI);
// 如果不需要处理,则直接放行
if (check){
log.info("本次请求{}不需要处理", requestURI);
filterChain.doFilter(request, response);
return;
}
// 判断登录状态,如果已登录,则直接放行
if (request.getSession().getAttribute("employee") != null){
log.info("用户已登录,用户id为:{}", request.getSession().getAttribute("employee"));
// 在同一线程中获取登录用户的id
Long emoId = (Long) request.getSession().getAttribute("employee");
BaseContext.setCurrentId(emoId);
filterChain.doFilter(request,response);
return;
}
// 判断登录状态,如果已登录,则直接放行
if (request.getSession().getAttribute("user") != null){
log.info("用户已登录,用户id为:{}", request.getSession().getAttribute("user"));
// 在同一线程中获取登录用户的id
Long emoId = (Long) request.getSession().getAttribute("user");
BaseContext.setCurrentId(emoId);
filterChain.doFilter(request,response);
return;
}
// 如果未登录则返回未登录结果,通过输出流方式向客户端响应数据
log.info("用户未登录");
response.getWriter().write(JSON.toJSONString((R.error("NOTLOGIN"))));
return;
}
/**
* 路径匹配,检查本次请求是否需要放行
* @param urls
* @param requestURI
* @return
*/
public boolean check(String urls[], String requestURI){
for (String url : urls){
boolean match = PATH_MATCHER.match(url,requestURI);
if (match){
return true;
}
}
return false;
}
}