Springboot+Vue博客项目总结

Posted 2022-12-19 ΘLLΘ

文章目录

• Springboot+Vue博客项目总结
• • 1.工程搭建
  • • 1.1 新建maven工程
    • 1.2 application.properties配置
    • 1.3 配置分页插件
    • 1.4 配置解决跨域
    • 1.5 添加启动类
  • 2.统一异常处理
  • 3.登录功能实现
  • • 3.1 接口说明
    • 3.2 JWT
    • 3.3 Controller
    • 3.4 Service
    • 3.5 登录参数，redis配置
  • 5.获取用户信息
  • • 5.1 接口说明
    • 5.2 Controller
    • 5.3 Service
  • 6.登录拦截器
  • • 6.1 拦截器实现
    • 6.2 使拦截器生效
  • 7.ThreadLocal保存用户信息
  • 8. 使用线程池更新阅读次数
  • • 8.1 线程池配置
    • 8.2 使用
  • 9.评论
  • • 9.1 接口说明
    • 9.2 加入到登录拦截器中
    • 9.3 Controller
    • 9.4 Service
  • 10.AOP统一记录日志
  • 11.文章图片上传
  • • 11.1 接口说明
    • 11.2 Controller
    • 11.3 使用七牛云
  • 12.AOP实习统一缓存处理（优化）
  • 13.年月归档中MySQL查询
  • • 13.1 Controller
    • 13.2 Service
    • 13.3 具体sql实现
  • 14.对后端进行返回统一的标准格式
  • • 14.1 定义返回对象
    • 14.2 定义状态码
  • 15.项目亮点总结

Springboot+Vue博客项目总结

1.工程搭建

1.1 新建maven工程

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.mszlu</groupId>
    <artifactId>blog-parent</artifactId>
    <version>1.0-SNAPSHOT</version>


    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.5.0</version>
        <relativePath/>
    </parent>

    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
        <java.version>1.8</java.version>
    </properties>

    <dependencies>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
            <!-- 排除 默认使用的logback  -->
            <exclusions>
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-logging</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

        <!-- log4j2 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-log4j2</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-aop</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-mail</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-redis</artifactId>
        </dependency>


        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>fastjson</artifactId>
            <version>1.2.76</version>
        </dependency>

        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>

        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
        </dependency>

        <dependency>
            <groupId>commons-collections</groupId>
            <artifactId>commons-collections</artifactId>
            <version>3.2.2</version>
        </dependency>

        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.4.3</version>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
        <!-- https://mvnrepository.com/artifact/joda-time/joda-time -->
        <dependency>
            <groupId>joda-time</groupId>
            <artifactId>joda-time</artifactId>
            <version>2.10.10</version>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

1.2 application.properties配置

#server
server.port= 8888
spring.application.name=mszlu_blog
# datasource
spring.datasource.url=jdbc:mysql://localhost:3306/blogxpp?useUnicode=true&characterEncoding=UTF-8&serverTimeZone=UTC
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

#mybatis-plus
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
#定义前缀表名，因为数据库中的表带ms_。这样实体类的表不用加前缀就可以匹配
mybatis-plus.global-config.db-config.table-prefix=ms_

1.3 配置分页插件

不知道的可以查看MyBatis-Plus官网关于分页插件的介绍

@Configuration
//扫包，将此包下的接口生成代理实现类，并且注册到spring容器中
@MapperScan("com.xpp.blog.dao.mapper")
public class MybatisPlusConfig 
    //集成分页插件
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor() 
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new PaginationInnerInterceptor());
        return interceptor;
    

1.4 配置解决跨域

解决跨域问题可以参考：SpringBoot解决跨域的5种方式

前后端端口不一样，需要解决跨域问题。

这里解决的方法是重写WebMvcConfigurer：

@Configuration
public class WebConfig implements WebMvcConfigurer 
    @Autowired
    private LoginInterceptor loginInterceptor;

    //跨域配置，前端和后端端口不一样
    @Override
    public void addCorsMappings(CorsRegistry registry) 
		//8080前端使用的端口号
        registry.addMapping("/**").allowedOrigins("http://localhost:8080");
    

1.5 添加启动类

@SpringBootApplication
public class BlogApp 
    public static void main(String[] args) 
        SpringApplication.run(BlogApp.class,args);
    

2.统一异常处理

不管是controller层还是service，dao层，都有可能报异常，如果是预料中的异常，可以直接捕获处理，如果是意料之外的异常，需要统一进行处理，进行记录，并给用户提示相对比较友好的信息。

• @ControllerAdvice：对加了@Controller的方法进行拦截处理，AOP的实现
• @ExceptionHandler：统一处理某一类异常，从而减少代码重复率和复杂度，比如要获取自定义异常可以@ExceptionHandler(BusinessException.class)

//作用：对加了@Controller的方法进行拦截处理，AOP的实现
@ControllerAdvice
public class AllExceptionHandler 
    //进行一次处理，处理Exception.class的异常
    @ExceptionHandler(Exception.class)
    //返回json数据，不加的话直接返回页面
    @ResponseBody
    public Result doException(Exception e)
        e.printStackTrace();
        return Result.fail(-999,"系统异常");
    

3.登录功能实现

3.1 接口说明

接口url：/login

请求方式：POST

请求参数：

参数名称	参数类型	说明
account	string	账号
password	string	密码

返回数据：

    "success": true,
    "code": 200,
    "msg": "success",
    "data": "token"

3.2 JWT

可以参考：JWT整合Springboot

登录使用JWT技术：

• jwt 可以生成 一个加密的token，做为用户登录的令牌，当用户登录成功之后，发放给客户端。
• 请求需要登录的资源或者接口的时候，将token携带，后端验证token是否合法。

jwt 有三部分组成：A.B.C

• A：Header，“type”:“JWT”,“alg”:“HS256” 固定
• B：playload，存放信息，比如，用户id，过期时间等等，可以被解密，不能存放敏感信息
• C: 签证，A和B加上秘钥加密而成，只要秘钥不丢失，可以认为是安全的。

jwt 验证，主要就是验证C部分是否合法。

依赖包：

<dependency>
    <groupId>io.jsonwebtoken</groupId>
    <artifactId>jjwt</artifactId>
    <version>0.9.1</version>
</dependency>

工具类：

public class JWTUtils 
    //密钥
    private static final String jwtToken = "123456Mszlu!@#$$";

    //生成token
    public static String createToken(Long userId)
        Map<String,Object> claims = new HashMap<>();
        claims.put("userId",userId);
        JwtBuilder jwtBuilder = Jwts.builder()
            .signWith(SignatureAlgorithm.HS256, jwtToken) // 签发算法，秘钥为jwtToken
            .setClaims(claims) // body数据，要唯一，自行设置
            .setIssuedAt(new Date()) // 设置签发时间
            .setExpiration(new Date(System.currentTimeMillis() + 24 * 60 * 60 * 60 * 1000));// 一天的有效时间
        String token = jwtBuilder.compact();
        return token;
    
    //检查token是否合法
    public static Map<String, Object> checkToken(String token)
        try 
            Jwt parse = Jwts.parser().setSigningKey(jwtToken).parse(token);
            return (Map<String, Object>) parse.getBody();
        catch (Exception e)
            e.printStackTrace();
        
        return null;

    

    public static void main(String[] args) 
        String token=JWTUtils.createToken(100L);
        System.out.println(token);
        Map<String, Object> map = JWTUtils.checkToken(token);
        System.out.println(map.get("userId"));
    

3.3 Controller

@RestController
@RequestMapping("login")
public class loginController 
    @Autowired
    private LoginService loginService;
    @PostMapping
    public Result login(@RequestBody LoginParam loginParam)
        //登录->验证用户
        return loginService.login(loginParam);
    

3.4 Service

关于这里StringUtils的用法：Java之StringUtils的常用方法

md5加密的依赖包：

<dependency>
    <groupId>commons-codec</groupId>
    <artifactId>commons-codec</artifactId>
</dependency>

@Service
public class LoginServiceImpl implements LoginService 
    @Autowired
    private SysUserService sysUserService;

    @Autowired
    private RedisTemplate<String, String> redisTemplate;

    //加密盐
    private static final String slat = "mszlu!@#";

    @Override
    public Result login(LoginParam loginParam) 
        //1.检查参数是否合法
        String account = loginParam.getAccount();
        String password = loginParam.getPassword();
        if (StringUtils.isBlank(account) || StringUtils.isAllBlank(password)) 
            return Result.fail(ErrorCode.PARAMS_ERROR.getCode(), ErrorCode.PARAMS_ERROR.getMsg());
        
        //用md5加密
        password = DigestUtils.md5Hex(password + slat);
        //2.根据用户名何密码去user表中查询 是否存在
        SysUser sysUser = sysUserService.findUser(account, password);
        //3.如果不存在 登录失败
        if (sysUser == null) 
            return Result.fail(ErrorCode.ACCOUNT_PWD_NOT_EXIST.getCode(), ErrorCode.ACCOUNT_PWD_NOT_EXIST.getMsg());
        

        //4.如果存在 使用jwt 生成token 返回给前端
        String token = JWTUtils.createToken(sysUser.getId());
        //5.toekn放入redis，设置过期时间。登录认证的时候先认证token字符串是否合法，在认证redsi认证是否合法
        redisTemplate.opsForValue().set("TOKEN_" + token, JSON.toJSONString(sysUser), 1, TimeUnit.DAYS);

        return Result.success(token);
    

/**
 * 根据account和password查询用户表
 * @param account
 * @param password
 * @return
 */
@Override
public SysUser 以上是关于Springboot+Vue博客项目总结的主要内容，如果未能解决你的问题，请参考以下文章
 
 Springboot+Vue博客项目总结
 超详细Docker部署SpringBoot+Vue项目（三更博客项目部署）
 SpringBoot练手项目总结
 01springboot+security+vue个人博客系统之项目创建
 SpringBoot和Vue集成视频播放组件——基于SpringBoot和Vue的后台管理系统项目系列博客（二十二）
 软件工程课程总结