springboot博客系统|SpringBoot+Vue快速搭建简单个人博客系统之后端

我是markerhub作者的一名粉丝,最初在markerhub公众号关注了博主,去B站白嫖了博主的基于SpringBoot+Vue开发的前后端分离博客项目完整教学的视频教程,看一遍跟着老师敲一遍,有的地方是直接Ctrl+C,Ctrl+V哈哈哈,今天转载了博主的项目博客,非常推荐这个博主(B站UP主;公众号号主; markerhub网站站长),嘻嘻嘻
小Hub领读:
前后端分离的博客项目终于出来啦,真是花了好多心思录制咧。文末直接进入B站看视频哈!

作者:吕一明
项目代码:https://github.com/MarkerHub/vueblog
项目视频:https://www.bilibili.com/video/BV1PQ4y1P7hZ/
转载请保留此引用,感谢!
前后端分离项目 文章总体分为2大部分,Java后端接口和vue前端页面,比较长,因为不想分开发布,真正想你4小时学会,哈哈。
目录:
springboot博客系统|SpringBoot+Vue快速搭建简单个人博客系统之后端
文章图片

先看效果:
springboot博客系统|SpringBoot+Vue快速搭建简单个人博客系统之后端
文章图片

springboot博客系统|SpringBoot+Vue快速搭建简单个人博客系统之后端
文章图片

不多说,开始敲代码。
Java后端接口开发 1、前言
从零开始搭建一个项目骨架,最好选择合适,熟悉的技术,并且在未来易拓展,适合微服务化体系等。所以一般以Springboot作为我们的框架基础,这是离不开的了。
然后数据层,我们常用的是Mybatis,易上手,方便维护。但是单表操作比较困难,特别是添加字段或减少字段的时候,比较繁琐,所以这里我推荐使用Mybatis Plus(https://mp.baomidou.com/),为简化开发而生,只需简单配置,即可快速进行 CRUD 操作,从而节省大量时间。
作为一个项目骨架,权限也是我们不能忽略的,Shiro配置简单,使用也简单,所以使用Shiro作为我们的的权限。
考虑到项目可能需要部署多台,这时候我们的会话等信息需要共享,Redis是现在主流的缓存中间件,也适合我们的项目。
然后因为前后端分离,所以我们使用jwt作为我们用户身份凭证。
ok,我们现在就开始搭建我们的项目脚手架!
技术栈:
  • SpringBoot
  • mybatis plus
  • shiro
  • lombok
  • redis
  • hibernate validatior
  • jwt
导图:https://www.markerhub.com/map/131
2、新建Springboot项目
这里,我们使用IDEA来开发我们项目,新建步骤比较简单,我们就不截图了。
开发工具与环境:
  • idea
  • mysql
  • jdk 8
  • maven3.3.9
新建好的项目结构如下,SpringBoot版本使用的目前最新的2.2.6.RELEASE版本
springboot博客系统|SpringBoot+Vue快速搭建简单个人博客系统之后端
文章图片

pom的jar包导入如下:
  1. org.springframework.boot
  2. spring-boot-starter-web
  3. org.springframework.boot
  4. spring-boot-devtools
  5. runtime
  6. true
  7. org.projectlombok
  8. lombok
  9. true

  • devtools:项目的热加载重启插件
  • lombok:简化代码的工具
3、整合mybatis plus
接下来,我们来整合mybatis plus,让项目能完成基本的增删改查操作。步骤很简单:可以去官网看看:https://mp.baomidou.com/guide/install.html
第一步:导入jar包
pom中导入mybatis plus的jar包,因为后面会涉及到代码生成,所以我们还需要导入页面模板引擎,这里我们用的是freemarker。
  1. com.baomidou
  2. mybatis-plus-boot-starter
  3. 3.2 .0
  4. org.springframework.boot
  5. spring-boot-starter-freemarker
  6. mysql
  7. mysql-connector-java
  8. runtime
  9. com.baomidou
  10. mybatis-plus-generator
  11. 3.2 .0

第二步:然后去写配置文件
  1. # DataSource Config
  2. spring:
  3. datasource:
  4. driver-class-name: com.mysql.cj.jdbc.Driver
  5. url: jdbc:mysql: //localhost:3306/vueblog?useUnicode=true&useSSL=false&characterEncoding=utf8&serverTimezone=Asia/Shanghai
  6. username: root
  7. password: admin
  8. mybatis-plus:
  9. mapper-locations: classpath*:/mapper /**Mapper.xml

上面除了配置数据库的信息,还配置了myabtis plus的mapper的xml文件的扫描路径,这一步不要忘记了。 第三步:开启mapper接口扫描,添加分页插件
新建一个包:通过@mapperScan注解指定要变成实现类的接口所在的包,然后包下面的所有接口在编译之后都会生成相应的实现类。PaginationInterceptor是一个分页插件。
  • com.markerhub.config.MybatisPlusConfig
  1. @Configuration
  2. @EnableTransactionManagement
  3. @MapperScan( "com.markerhub.mapper")
  4. public class MybatisPlusConfig {
  5. @Bean
  6. public PaginationInterceptor paginationInterceptor() {
  7. PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
  8. return paginationInterceptor;
  9. }
  10. }

第四步:代码生成
如果你没再用其他插件,那么现在就已经可以使用mybatis plus了,官方给我们提供了一个代码生成器,然后我写上自己的参数之后,就可以直接根据数据库表信息生成entity、service、mapper等接口和实现类。
  • com.markerhub.CodeGenerator
因为代码比较长,就不贴出来了,在代码仓库上看哈!
首先我在数据库中新建了一个user表:
  1. CREATE TABLE `m_user` (
  2. `id` bigint( 20) NOT NULL AUTO_INCREMENT,
  3. `username` varchar( 64) DEFAULT NULL,
  4. `avatar` varchar( 255) DEFAULT NULL,
  5. `email` varchar( 64) DEFAULT NULL,
  6. `password` varchar( 64) DEFAULT NULL,
  7. `status` int( 5) NOT NULL,
  8. `created` datetime DEFAULT NULL,
  9. `last_login` datetime DEFAULT NULL,
  10. PRIMARY KEY ( `id`),
  11. KEY `UK_USERNAME` ( `username`) USING BTREE
  12. ) ENGINE=InnoDB DEFAULT CHARSET=utf8;
  13. CREATE TABLE `m_blog` (
  14. `id` bigint( 20) NOT NULL AUTO_INCREMENT,
  15. `user_id` bigint( 20) NOT NULL,
  16. `title` varchar( 255) NOT NULL,
  17. `description` varchar( 255) NOT NULL,
  18. `content` longtext,
  19. `created` datetime NOT NULL ON UPDATE CURRENT_TIMESTAMP,
  20. `status` tinyint( 4) DEFAULT NULL,
  21. PRIMARY KEY ( `id`)
  22. ) ENGINE=InnoDB AUTO_INCREMENT= 11 DEFAULT CHARSET=utf8mb4;
  23. INSERT INTO `vueblog`. `m_user` ( `id`, `username`, `avatar`, `email`, `password`, `status`, `created`, `last_login`) VALUES ( '1', 'markerhub', 'https://image-1300566513.cos.ap-guangzhou.myqcloud.com/upload/images/5a9f48118166308daba8b6da7e466aab.jpg', NULL, '96e79218965eb72c92a549dd5a330112', '0', '2020-04-20 10:44:01', NULL);

运行CodeGenerator的main方法,输入表名:m_user,生成结果如下: springboot博客系统|SpringBoot+Vue快速搭建简单个人博客系统之后端
文章图片

得到:
springboot博客系统|SpringBoot+Vue快速搭建简单个人博客系统之后端
文章图片

简洁!方便!经过上面的步骤,基本上我们已经把mybatis plus框架集成到项目中了。
ps:额,注意一下m_blog表的代码也生成一下哈。
在UserController中写个测试:
  1. @RestController
  2. @RequestMapping( "/user")
  3. public class UserController {
  4. @Autowired
  5. UserService userService;
  6. @GetMapping( "/{id}")
  7. public Object test(@PathVariable( "id") Long id) {
  8. return userService.getById(id);
  9. }
  10. }

访问:http://localhost:8080/user/1 获得结果如下,整合成功! springboot博客系统|SpringBoot+Vue快速搭建简单个人博客系统之后端
文章图片

3、统一结果封装
这里我们用到了一个Result的类,这个用于我们的异步统一返回的结果封装。一般来说,结果里面有几个要素必要的
  • 是否成功,可用code表示(如200表示成功,400表示异常)
  • 结果消息
  • 结果数据
所以可得到封装如下:
  • com.markerhub.common.lang.Result
  1. @Data
  2. public class Result implements Serializable {
  3. private String code;
  4. private String msg;
  5. private Object data;
  6. public static Result succ(Object data) {
  7. Result m = new Result();
  8. m.setCode( "0");
  9. m.setData(data);
  10. m.setMsg( "操作成功");
  11. return m;
  12. }
  13. public static Result succ(String mess, Object data) {
  14. Result m = new Result();
  15. m.setCode( "0");
  16. m.setData(data);
  17. m.setMsg(mess);
  18. return m;
  19. }
  20. public static Result fail(String mess) {
  21. Result m = new Result();
  22. m.setCode( "-1");
  23. m.setData(null);
  24. m.setMsg(mess);
  25. return m;
  26. }
  27. public static Result fail(String mess, Object data) {
  28. Result m = new Result();
  29. m.setCode( "-1");
  30. m.setData(data);
  31. m.setMsg(mess);
  32. return m;
  33. }
  34. }

4、整合shiro+jwt,并会话共享
考虑到后面可能需要做集群、负载均衡等,所以就需要会话共享,而shiro的缓存和会话信息,我们一般考虑使用redis来存储这些数据,所以,我们不仅仅需要整合shiro,同时也需要整合redis。在开源的项目中,我们找到了一个starter可以快速整合shiro-redis,配置简单,这里也推荐大家使用。
而因为我们需要做的是前后端分离项目的骨架,所以一般我们会采用token或者jwt作为跨域身份验证解决方案。所以整合shiro的过程中,我们需要引入jwt的身份验证过程。
那么我们就开始整合:
我们使用一个shiro-redis-spring-boot-starter的jar包,具体教程可以看官方文档:https://github.com/alexxiyang/shiro-redis/blob/master/docs/README.md#spring-boot-starter
第一步:导入shiro-redis的starter包:还有jwt的工具包,以及为了简化开发,我引入了hutool工具包。
  1. org.crazycake
  2. shiro-redis-spring-boot-starter
  3. 3.2 .1
  4. cn.hutool
  5. hutool-all
  6. 5.3 .3
  7. io.jsonwebtoken
  8. jjwt
  9. 0.9 .1

第二步:编写配置:
ShiroConfig
  • com.markerhub.config.ShiroConfig
  1. /**
  2. * shiro启用注解拦截控制器
  3. */
  4. @Configuration
  5. public class ShiroConfig {
  6. @Autowired
  7. JwtFilter jwtFilter;
  8. @Bean
  9. public SessionManager sessionManager(RedisSessionDAO redisSessionDAO) {
  10. DefaultWebSessionManager sessionManager = new DefaultWebSessionManager();
  11. sessionManager.setSessionDAO(redisSessionDAO);
  12. return sessionManager;
  13. }
  14. @Bean
  15. public DefaultWebSecurityManager securityManager(AccountRealm accountRealm,
  16. SessionManager sessionManager,
  17. RedisCacheManager redisCacheManager) {
  18. DefaultWebSecurityManager securityManager = new DefaultWebSecurityManager(accountRealm);
  19. securityManager.setSessionManager(sessionManager);
  20. securityManager.setCacheManager(redisCacheManager);
  21. /*
  22. * 关闭shiro自带的session,详情见文档
  23. */
  24. DefaultSubjectDAO subjectDAO = new DefaultSubjectDAO();
  25. DefaultSessionStorageEvaluator defaultSessionStorageEvaluator = new DefaultSessionStorageEvaluator();
  26. defaultSessionStorageEvaluator.setSessionStorageEnabled( false);
  27. subjectDAO.setSessionStorageEvaluator(defaultSessionStorageEvaluator);
  28. securityManager.setSubjectDAO(subjectDAO);
  29. return securityManager;
  30. }
  31. @Bean
  32. public ShiroFilterChainDefinition shiroFilterChainDefinition() {
  33. DefaultShiroFilterChainDefinition chainDefinition = new DefaultShiroFilterChainDefinition();
  34. Map filterMap = new LinkedHashMap<>();
  35. filterMap.put( "/**", "jwt"); // 主要通过注解方式校验权限
  36. chainDefinition.addPathDefinitions(filterMap);
  37. return chainDefinition;
  38. }
  39. @Bean( "shiroFilterFactoryBean")
  40. public ShiroFilterFactoryBean shiroFilterFactoryBean(SecurityManager securityManager,
  41. ShiroFilterChainDefinition shiroFilterChainDefinition) {
  42. ShiroFilterFactoryBean shiroFilter = new ShiroFilterFactoryBean();
  43. shiroFilter.setSecurityManager(securityManager);
  44. Map filters = new HashMap<>();
  45. filters.put( "jwt", jwtFilter);
  46. shiroFilter.setFilters(filters);
  47. Map filterMap = shiroFilterChainDefinition.getFilterChainMap();
  48. shiroFilter.setFilterChainDefinitionMap(filterMap);
  49. return shiroFilter;
  50. }
  51. // 开启注解代理(默认好像已经开启,可以不要)
  52. @Bean
  53. public AuthorizationAttributeSourceAdvisor authorizationAttributeSourceAdvisor(SecurityManager securityManager){
  54. AuthorizationAttributeSourceAdvisor authorizationAttributeSourceAdvisor = new AuthorizationAttributeSourceAdvisor();
  55. authorizationAttributeSourceAdvisor.setSecurityManager(securityManager);
  56. return authorizationAttributeSourceAdvisor;
  57. }
  58. @Bean
  59. public static DefaultAdvisorAutoProxyCreator getDefaultAdvisorAutoProxyCreator() {
  60. DefaultAdvisorAutoProxyCreator creator = new DefaultAdvisorAutoProxyCreator();
  61. return creator;
  62. }
  63. }

上面ShiroConfig,我们主要做了几件事情:
  1. 引入RedisSessionDAO和RedisCacheManager,为了解决shiro的权限数据和会话信息能保存到redis中,实现会话共享。
  2. 重写了SessionManager和DefaultWebSecurityManager,同时在DefaultWebSecurityManager中为了关闭shiro自带的session方式,我们需要设置为false,这样用户就不再能通过session方式登录shiro。后面将采用jwt凭证登录。
  3. 在ShiroFilterChainDefinition中,我们不再通过编码形式拦截Controller访问路径,而是所有的路由都需要经过JwtFilter这个过滤器,然后判断请求头中是否含有jwt的信息,有就登录,没有就跳过。跳过之后,有Controller中的shiro注解进行再次拦截,比如@RequiresAuthentication,这样控制权限访问。
那么,接下来,我们聊聊ShiroConfig中出现的AccountRealm,还有JwtFilter。
AccountRealm
AccountRealm是shiro进行登录或者权限校验的逻辑所在,算是核心了,我们需要重写3个方法,分别是
  • supports:为了让realm支持jwt的凭证校验
  • doGetAuthorizationInfo:权限校验
  • doGetAuthenticationInfo:登录认证校验
我们先来总体看看AccountRealm的代码,然后逐个分析:
  • com.markerhub.shiro.AccountRealm
  1. @Slf4j
  2. @Component
  3. public class AccountRealm extends AuthorizingRealm {
  4. @Autowired
  5. JwtUtils jwtUtils;
  6. @Autowired
  7. UserService userService;
  8. @Override
  9. public boolean supports(AuthenticationToken token) {
  10. return token instanceof JwtToken;
  11. }
  12. @Override
  13. protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principals) {
  14. return null;
  15. }
  16. @Override
  17. protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken token) throws AuthenticationException {
  18. JwtToken jwt = (JwtToken) token;
  19. log.info( "jwt----------------->{}", jwt);
  20. String userId = jwtUtils.getClaimByToken((String) jwt.getPrincipal()).getSubject();
  21. User user = userService.getById(Long.parseLong(userId));
  22. if(user == null) {
  23. throw new UnknownAccountException( "账户不存在!");
  24. }
  25. if(user.getStatus() == -1) {
  26. throw new LockedAccountException( "账户已被锁定!");
  27. }
  28. AccountProfile profile = new AccountProfile();
  29. BeanUtil.copyProperties(user, profile);
  30. log.info( "profile----------------->{}", profile.toString());
  31. return new SimpleAuthenticationInfo(profile, jwt.getCredentials(), getName());
  32. }
  33. }

其实主要就是doGetAuthenticationInfo登录认证这个方法,可以看到我们通过jwt获取到用户信息,判断用户的状态,最后异常就抛出对应的异常信息,否者封装成SimpleAuthenticationInfo返回给shiro。接下来我们逐步分析里面出现的新类:
1、shiro默认supports的是UsernamePasswordToken,而我们现在采用了jwt的方式,所以这里我们自定义一个JwtToken,来完成shiro的supports方法。
JwtToken
  • com.markerhub.shiro.JwtToken
  1. public class JwtToken implements AuthenticationToken {
  2. private String token;
  3. public JwtToken(String token) {
  4. this.token = token;
  5. }
  6. @Override
  7. public Object getPrincipal() {
  8. return token;
  9. }
  10. @Override
  11. public Object getCredentials() {
  12. return token;
  13. }
  14. }

2、JwtUtils是个生成和校验jwt的工具类,其中有些jwt相关的密钥信息是从项目配置文件中配置的:
  1. @Component
  2. @ConfigurationProperties(prefix = "markerhub.jwt")
  3. public class JwtUtils {
  4. private String secret;
  5. private long expire;
  6. private String header;
  7. /**
  8. * 生成jwt token
  9. */
  10. public String generateToken(long userId) {
  11. ...
  12. }
  13. // 获取jwt的信息
  14. public Claims getClaimByToken(String token) {
  15. ...
  16. }
  17. /**
  18. * token是否过期
  19. * @returntrue:过期
  20. */
  21. public boolean isTokenExpired(Date expiration) {
  22. return expiration.before( new Date());
  23. }
  24. }

3、而在AccountRealm我们还用到了AccountProfile,这是为了登录成功之后返回的一个用户信息的载体,
AccountProfile
  • com.markerhub.shiro.AccountProfile
  1. @Data
  2. public class AccountProfile implements Serializable {
  3. private Long id;
  4. private String username;
  5. private String avatar;
  6. }

第三步,ok,基本的校验的路线完成之后,我们需要少量的基本信息配置:
  1. shiro-redis:
  2. enabled: true
  3. redis-manager:
  4. host: 127.0 .0 .1: 6379
  5. markerhub:
  6. jwt:
  7. # 加密秘钥
  8. secret: f4e2e52034348f86b67cde581c0f9eb5
  9. # token有效时长, 7天,单位秒
  10. expire: 604800
  11. header: token

第四步:另外,如果你项目有使用spring-boot-devtools,需要添加一个配置文件,在resources目录下新建文件夹META-INF,然后新建文件spring-devtools.properties,这样热重启时候才不会报错。
  • resources/META-INF/spring-devtools.properties
restart.include.shiro-redis=/shiro-[\\w-\\.]+jar

springboot博客系统|SpringBoot+Vue快速搭建简单个人博客系统之后端
文章图片

【springboot博客系统|SpringBoot+Vue快速搭建简单个人博客系统之后端】JwtFilter
第五步:定义jwt的过滤器JwtFilter。
这个过滤器是我们的重点,这里我们继承的是Shiro内置的AuthenticatingFilter,一个可以内置了可以自动登录方法的的过滤器,有些同学继承BasicHttpAuthenticationFilter也是可以的。
我们需要重写几个方法:
  1. createToken:实现登录,我们需要生成我们自定义支持的JwtToken
  2. onAccessDenied:拦截校验,当头部没有Authorization时候,我们直接通过,不需要自动登录;当带有的时候,首先我们校验jwt的有效性,没问题我们就直接执行executeLogin方法实现自动登录
  3. onLoginFailure:登录异常时候进入的方法,我们直接把异常信息封装然后抛出
  4. preHandle:拦截器的前置拦截,因为我们是前后端分析项目,项目中除了需要跨域全局配置之外,我们再拦截器中也需要提供跨域支持。这样,拦截器才不会在进入Controller之前就被限制了。
下面我们看看总体的代码:
  • com.markerhub.shiro.JwtFilter
  1. @Component
  2. public class JwtFilter extends AuthenticatingFilter {
  3. @Autowired
  4. JwtUtils jwtUtils;
  5. @Override
  6. protected AuthenticationToken createToken(ServletRequest servletRequest, ServletResponse servletResponse) throws Exception {
  7. // 获取 token
  8. HttpServletRequest request = (HttpServletRequest) servletRequest;
  9. String jwt = request.getHeader( "Authorization");
  10. if(StringUtils.isEmpty(jwt)){
  11. return null;
  12. }
  13. return new JwtToken(jwt);
  14. }
  15. @Override
  16. protected boolean onAccessDenied(ServletRequest servletRequest, ServletResponse servletResponse) throws Exception {
  17. HttpServletRequest request = (HttpServletRequest) servletRequest;
  18. String token = request.getHeader( "Authorization");
  19. if(StringUtils.isEmpty(token)) {
  20. return true;
  21. } else {
  22. // 判断是否已过期
  23. Claims claim = jwtUtils.getClaimByToken(token);
  24. if(claim == null || jwtUtils.isTokenExpired(claim.getExpiration())) {
  25. throw new ExpiredCredentialsException( "token已失效,请重新登录!");
  26. }
  27. }
  28. // 执行自动登录
  29. return executeLogin(servletRequest, servletResponse);
  30. }
  31. @Override
  32. protected boolean onLoginFailure(AuthenticationToken token, AuthenticationException e, ServletRequest request, ServletResponse response) {
  33. HttpServletResponse httpResponse = (HttpServletResponse) response;
  34. try {
  35. //处理登录失败的异常
  36. Throwable throwable = e.getCause() == null ? e : e.getCause();
  37. Result r = Result.fail(throwable.getMessage());
  38. String json = JSONUtil.toJsonStr(r);
  39. httpResponse.getWriter(). print(json);
  40. } catch (IOException e1) {
  41. }
  42. return false;
  43. }
  44. /**
  45. * 对跨域提供支持
  46. */
  47. @Override
  48. protected boolean preHandle(ServletRequest request, ServletResponse response) throws Exception {
  49. HttpServletRequest httpServletRequest = WebUtils.toHttp(request);
  50. HttpServletResponse httpServletResponse = WebUtils.toHttp(response);
  51. httpServletResponse.setHeader( "Access-control-Allow-Origin", httpServletRequest.getHeader( "Origin"));
  52. httpServletResponse.setHeader( "Access-Control-Allow-Methods", "GET,POST,OPTIONS,PUT,DELETE");
  53. httpServletResponse.setHeader( "Access-Control-Allow-Headers", httpServletRequest.getHeader( "Access-Control-Request-Headers"));
  54. // 跨域时会首先发送一个OPTIONS请求,这里我们给OPTIONS请求直接返回正常状态
  55. if (httpServletRequest.getMethod().equals(RequestMethod.OPTIONS.name())) {
  56. httpServletResponse.setStatus(org.springframework.http.HttpStatus.OK.value());
  57. return false;
  58. }
  59. return super.preHandle(request, response);
  60. }
  61. }

那么到这里,我们的shiro就已经完成整合进来了,并且使用了jwt进行身份校验。
5、异常处理
有时候不可避免服务器报错的情况,如果不配置异常处理机制,就会默认返回tomcat或者nginx的5XX页面,对普通用户来说,不太友好,用户也不懂什么情况。这时候需要我们程序员设计返回一个友好简单的格式给前端。
处理办法如下:通过使用@ControllerAdvice来进行统一异常处理,@ExceptionHandler(value = https://www.it610.com/article/RuntimeException.class)来指定捕获的Exception各个类型异常 ,这个异常的处理,是全局的,所有类似的异常,都会跑到这个地方处理。
  • com.markerhub.common.exception.GlobalExceptionHandler
步骤二、定义全局异常处理,@ControllerAdvice表示定义全局控制器异常处理,@ExceptionHandler表示针对性异常处理,可对每种异常针对性处理。
  1. /**
  2. * 全局异常处理
  3. */
  4. @Slf4j
  5. @RestControllerAdvice
  6. public class GlobalExcepitonHandler {
  7. // 捕捉shiro的异常
  8. @ResponseStatus(HttpStatus.UNAUTHORIZED)
  9. @ExceptionHandler(ShiroException.class)
  10. public Result handle401(ShiroException e) {
  11. return Result.fail( 401, e.getMessage(), null);
  12. }
  13. /**
  14. * 处理Assert的异常
  15. */
  16. @ResponseStatus(HttpStatus.BAD_REQUEST)
  17. @ExceptionHandler(value = https://www.it610.com/article/IllegalArgumentException.class)
  18. public Result handler(IllegalArgumentException e) throws IOException {
  19. log.error( "Assert异常:-------------->{}",e.getMessage());
  20. return Result.fail(e.getMessage());
  21. }
  22. /**
  23. * @Validated 校验错误异常处理
  24. */
  25. @ResponseStatus(HttpStatus.BAD_REQUEST)
  26. @ExceptionHandler(value = https://www.it610.com/article/MethodArgumentNotValidException.class)
  27. public Result handler(MethodArgumentNotValidException e) throws IOException {
  28. log.error( "运行时异常:-------------->",e);
  29. BindingResult bindingResult = e.getBindingResult();
  30. ObjectError objectError = bindingResult.getAllErrors().stream().findFirst().get();
  31. return Result.fail(objectError.getDefaultMessage());
  32. }
  33. @ResponseStatus(HttpStatus.BAD_REQUEST)
  34. @ExceptionHandler(value = https://www.it610.com/article/RuntimeException.class)
  35. public Result handler(RuntimeException e) throws IOException {
  36. log.error( "运行时异常:-------------->",e);
  37. return Result.fail(e.getMessage());
  38. }
  39. }

上面我们捕捉了几个异常:
  • ShiroException:shiro抛出的异常,比如没有权限,用户登录异常
  • IllegalArgumentException:处理Assert的异常
  • MethodArgumentNotValidException:处理实体校验的异常
  • RuntimeException:捕捉其他异常
6、实体校验
当我们表单数据提交的时候,前端的校验我们可以使用一些类似于jQuery Validate等js插件实现,而后端我们可以使用Hibernate validatior来做校验。
我们使用springboot框架作为基础,那么就已经自动集成了Hibernate validatior。
那么用起来啥样子的呢?
第一步:首先在实体的属性上添加对应的校验规则,比如:
  1. @TableName( "m_user")
  2. public class User implements Serializable {
  3. private static final long serialVersionUID = 1L;
  4. @TableId(value = "https://www.it610.com/article/id", type = IdType.AUTO)
  5. private Long id;
  6. @NotBlank(message = "昵称不能为空")
  7. private String username;
  8. @NotBlank(message = "邮箱不能为空")
  9. @Email(message = "邮箱格式不正确")
  10. private String email;
  11. ...
  12. }

第二步 :这里我们使用@Validated注解方式,如果实体不符合要求,系统会抛出异常,那么我们的异常处理中就捕获到MethodArgumentNotValidException。
  • com.markerhub.controller.UserController
  1. /**
  2. * 测试实体校验
  3. * @param user
  4. * @return
  5. */
  6. @PostMapping( "/save")
  7. public Object testUser(@Validated @RequestBody User user) {
  8. return user.toString();
  9. }

7、跨域问题
因为是前后端分析,所以跨域问题是避免不了的,我们直接在后台进行全局跨域处理:
  • com.markerhub.config.CorsConfig
  1. /**
  2. * 解决跨域问题
  3. */
  4. @Configuration
  5. public class CorsConfig implements WebMvcConfigurer {
  6. @Override
  7. public void addCorsMappings(CorsRegistry registry) {
  8. registry.addMapping( "/**")
  9. .allowedOrigins( "*")
  10. .allowedMethods( "GET", "HEAD", "POST", "PUT", "DELETE", "OPTIONS")
  11. .allowCredentials( true)
  12. .maxAge( 3600)
  13. .allowedHeaders( "*");
  14. }
  15. }

ok,因为我们系统开发的接口比较简单,所以我就不集成swagger2啦,也比较简单而已。下面我们就直接进入我们的正题,进行编写登录接口。
8、登录接口开发
登录的逻辑其实很简答,只需要接受账号密码,然后把用户的id生成jwt,返回给前段,为了后续的jwt的延期,所以我们把jwt放在header上。具体代码如下:
  • com.markerhub.controller.AccountController
  1. @RestController
  2. public class AccountController {
  3. @Autowired
  4. JwtUtils jwtUtils;
  5. @Autowired
  6. UserService userService;
  7. /**
  8. * 默认账号密码:markerhub / 111111
  9. *
  10. */
  11. @CrossOrigin
  12. @PostMapping( "/login")
  13. public Result login(@Validated @RequestBody LoginDto loginDto, HttpServletResponse response) {
  14. User user = userService.getOne( new QueryWrapper().eq( "username", loginDto.getUsername()));
  15. Assert.notNull(user, "用户不存在");
  16. if(!user.getPassword().equals(SecureUtil.md5(loginDto.getPassword()))) {
  17. return Result.fail( "密码错误!");
  18. }
  19. String jwt = jwtUtils.generateToken(user.getId());
  20. response.setHeader( "Authorization", jwt);
  21. response.setHeader( "Access-Control-Expose-Headers", "Authorization");
  22. // 用户可以另一个接口
  23. return Result.succ(MapUtil.builder()
  24. .put( "id", user.getId())
  25. .put( "username", user.getUsername())
  26. .put( "avatar", user.getAvatar())
  27. .put( "email", user.getEmail())
  28. . map()
  29. );
  30. }
  31. // 退出
  32. @GetMapping( "/logout")
  33. @RequiresAuthentication
  34. public Result logout() {
  35. SecurityUtils.getSubject().logout();
  36. return Result.succ(null);
  37. }
  38. }

接口测试: springboot博客系统|SpringBoot+Vue快速搭建简单个人博客系统之后端
文章图片

9、博客接口开发
我们的骨架已经完成,接下来,我们就可以添加我们的业务接口了,下面我以一个简单的博客列表、博客详情页为例子开发:
  • com.markerhub.controller.BlogController
  1. @RestController
  2. public class BlogController {
  3. @Autowired
  4. BlogService blogService;
  5. @GetMapping( "/blogs")
  6. public Result blogs(Integer currentPage) {
  7. if(currentPage == null || currentPage < 1) currentPage = 1;
  8. Page page = new Page(currentPage, 5)
  9. IPage pageData = https://www.it610.com/article/blogService.page(page, new QueryWrapper().orderByDesc( "created"));
  10. return Result.succ(pageData);
  11. }
  12. @GetMapping( "/blog/{id}")
  13. public Result detail(@PathVariable(name = "id") Long id) {
  14. Blog blog = blogService.getById(id);
  15. Assert.notNull(blog, "该博客已删除!");
  16. return Result.succ(blog);
  17. }
  18. @RequiresAuthentication
  19. @PostMapping( "/blog/edit")
  20. public Result edit(@Validated @RequestBody Blog blog) {
  21. System.out. println(blog.toString());
  22. Blog temp = null;
  23. if(blog.getId() != null) {
  24. temp = blogService.getById(blog.getId());
  25. Assert.isTrue(temp.getUserId() == ShiroUtil.getProfile().getId(), "没有权限编辑");
  26. } else {
  27. temp = new Blog();
  28. temp.setUserId(ShiroUtil.getProfile().getId());
  29. temp.setCreated(LocalDateTime.now());
  30. temp.setStatus( 0);
  31. }
  32. BeanUtil.copyProperties(blog, temp, "id", "userId", "created", "status");
  33. blogService.saveOrUpdate(temp);
  34. return Result.succ( "操作成功", null);
  35. }
  36. }

注意@RequiresAuthentication说明需要登录之后才能访问的接口,其他需要权限的接口可以添加shiro的相关注解。接口比较简单,我们就不多说了,基本增删改查而已。注意的是edit方法是需要登录才能操作的受限资源。
接口测试:
springboot博客系统|SpringBoot+Vue快速搭建简单个人博客系统之后端
文章图片

10、后端总结
好了,一篇文章搞定一个基本骨架,好像有点赶,但是基本的东西这里已经有了。后面我们就要去开发我们的前端接口了。
项目代码:https://github.com/MarkerHub/vueblog
项目视频:https://www.bilibili.com/video/BV1PQ4y1P7hZ/

    推荐阅读