⭐ 作者简介:码上言
⭐ 代表教程:Spring Boot + vue-element 开发个人博客项目实战教程
项目部署视频
https://www.bilibili.com/video/BV1sg4y1A7Kv/?vd_source=dc7bf298d3c608d281c16239b3f5167b
文章目录
前言
我们接着前一章写,前面一章我们已经将前端搭建完成,还做了一些简单的修改,下面我们开始做后台的接口,还有一些逻辑需要写。
一、后端登录功能
1、新建登录接口
接下来我们来写后端的接口,前端先告一段落,通过上边前端模板的登录流程来分析,我们现在先写两个接口。在前端我们看到api的文件中那个接口地址为/user/login
和/user/info
这两个接口,我们打开后端代码,打开UserController
,找到最上边我们就会看到,当初我们写接口的时候正好定义的/user
。
@RequestMapping("/user") public class UserController { }
所以我们只要写login即可。在写之前还要写一个实体类,用于接收前端传来的用户和密码。
在entity包中新建一个LoginModel.java
实体类,里面定义两个属性,用户名和密码
package com.blog.personalblog.entity; import lombok.Data; /** * @author: SuperMan * @create: 2022-03-25 **/ @Data public class LoginModel { /** * username: admin * password: 123456 */ private String username; private String password; }
然后新建两个空的接口。
/** * 登录 * @param loginModel * @return */ @PostMapping("/login") public JsonResult<Object> login(@RequestBody LoginModel loginModel){ logger.info("{} 在请求登录! ", loginModel.getUsername()); return JsonResult.success(); } /** * 登录info信息 * @return */ @GetMapping("/info") public JsonResult<Object> info(){ return JsonResult.success(); }
此时login方法中的logger会报错,这个是我们自己定义的,在类的最上边定义一下,会在控制台打印日志信息。
private Logger logger = LoggerFactory.getLogger(this.getClass());
2、shiro的引入
这里我们要引入了后台登录最重要的技术shiro,首先我们要先了解这个是干嘛的,才能去引用,有些东西我们要多了解,这样在别人谈论某件事的时候,我们才会有谈资。
2.1、简介
Apache Shiro
是 Java 的一个安全框架。目前,使用 Apache Shiro
的人越来越多,因为它相当简单,对比 Spring Security
,可能没有 pring Security
做的功能强大,但是在实际工作时可能并不需要那么复杂的东西,所以使用小而简单的 Shiro 就足够了。对于它俩到底哪个好,这个不必纠结,能更简单的解决项目问题就好了。● Authentication:身份认证 / 登录,验证用户是不是拥有相应的身份;
● Authorization:授权,即权限验证,验证某个已认证的用户是否拥有某个权限;即判断用户是否能做事情,常见的如:验证某个用户是否拥有某个角色。或者细粒度的验证某个用户对某个资源是否具有某个权限;
● Session Management:会话管理,即用户登录后就是一次会话,在没有退出之前,它的所有信息都在会话中;会话可以是普通 JavaSE 环境的,也可以是如 Web 环境的;
● Cryptography:加密,保护数据的安全性,如密码加密存储到数据库,而不是明文存储;
● Web Support:Web 支持,可以非常容易的集成到 Web 环境;
● Caching:缓存,比如用户登录后,其用户信息、拥有的角色 / 权限不必每次去查,这样可以提高效率;
● Concurrency:shiro 支持多线程应用的并发验证,即如在一个线程中开启另一个线程,能把权限自动传播过去;
● Testing:提供测试支持;
● Run As:允许一个用户假装为另一个用户(如果他们允许)的身份进行访问;
● Remember Me:记住我,这个是非常常见的功能,即一次登录后,下次再来的话不用登录了。
2.2、架构
记住一点,Shiro 不会去维护用户、维护权限;这些需要我们自己去设计 / 提供;然后通过相应的接口注入给 Shiro 即可。
关于 Shiro,需要理解三个核心概念:Subject
、SecurityManager
和 Realms
。可以看到:应用代码直接交互的对象是 Subject,也就是说 Shiro 的对外 API 核心就是 Subject;其每个 API 的含义:
Subject:主体,代表了当前 “用户”,这个用户不一定是一个具体的人,与当前应用交互的任何东西都是 Subject,如网络爬虫,机器人等;即一个抽象概念;所有 Subject 都绑定到 SecurityManager,与 Subject 的所有交互都会委托给 SecurityManager;可以把 Subject 认为是一个门面;SecurityManager 才是实际的执行者;
SecurityManager:安全管理器;即所有与安全有关的操作都会与 SecurityManager 交互;且它管理着所有 Subject;可以看出它是 Shiro 的核心,它负责与后边介绍的其他组件进行交互,如果学习过 SpringMVC,你可以把它看成 DispatcherServlet 前端控制器;
Realm:域,Shiro 从 Realm 获取安全数据(如用户、角色、权限),就是说 SecurityManager 要验证用户身份,那么它需要从 Realm 获取相应的用户进行比较以确定用户身份是否合法;也需要从 Realm 得到用户相应的角色 / 权限进行验证用户是否能进行操作;可以把Realm看成 DataSource,即安全数据源。
也就是说对于我们而言,最简单的一个 Shiro 应用:
1.应用代码通过 Subject 来进行认证和授权,而 Subject 又委托给 SecurityManager;
2.我们需要给 Shiro 的 SecurityManager 注入 Realm,从而让 SecurityManager
能得到合法的用户及其权限进行判断。
从以上也可以看出,Shiro 不提供维护用户 / 权限,而是通过 Realm 让开发人员自己注入。
好啦,我就先放这些知识吧,大家看一看了解怎么回事就行,具体的还得我们实际的应用才能掌握。
想要了解更多的,可以看看这个基础的:https://www.w3cschool.cn/shiro/andc1if0.html
2.3、添加shiro依赖
我们想要使用shiro就要引入maven依赖
<dependency> <groupId>org.apache.shiro</groupId> <artifactId>shiro-spring</artifactId> <version>1.4.0</version> </dependency>
然后我们再去这个根据用户名查询用户对象的接口,我们打开UserService.java
,然后添加一个接口
/** * username * @param userName * @return */ User getUserByUserName(String userName);
实现类UserServiceImpl.java
:
@Override public User getUserByUserName(String userName) { if (userName == null) { return null; } User user = userMapper.findByUsername(userName); return user; }
然后写Mapper接口,打开UserMapper.java
/** * username * @param userName * @return */ User findByUsername(String userName);
再去写sql语句,UserMapper.java
<select id="findByUsername" parameterType="java.lang.String" resultMap="BaseResultMap"> select * from person_user where username = #{userName, jdbcType=VARCHAR} </select>
准备工作写完后,我们去配置shiro环境
3、配置shiro
配置的顺序如下:
- 1.创建 Realm 并重写获取认证与授权信息的方法。
- 2.创建配置类,包括创建并配置 SecurityManager 等。
3.1、MyShiroRealm.java
在我们的项目上新建一个shiro包
,在这个包里新建一个MyShiroRealm.java
。前面在介绍shiro的时候也说了Realm
,我们创建 Realm 并重写获取认证与授权信息的方法。
我们创建完之后,然后再继承一下AuthorizingRealm父类。UserRealm 父类 AuthorizingRealm 将获取 Subject 相关信息分成两步:获取身份验证信息(doGetAuthenticationInfo)及授权信息(doGetAuthorizationInfo)我们来验证下是不是有这两个方法。
鼠标浮上去,然后看到我上方框起来的Implment methods
,点击,弹出一个框,看这就是我上边说的那两个重写的方法,全选中然后点Ok即可。(代码我讲完这个类下面再贴)
我找了些资料,看着讲解的还挺详细,大家可以看一下对着两个方法的讲解。
1.doGetAuthenticationInfo 获取身份验证相关信息:首先根据传入的用户名获取 User 信息;然后如果 user 为空,那么抛出没找到帐号异常 UnknownAccountException;如果 user 找到但锁定了抛出锁定异常 LockedAccountException;最后生成 AuthenticationInfo 信息,交给间接父类 AuthenticatingRealm 使用 CredentialsMatcher 进行判断密码是否匹配,如果不匹配将抛出密码错误异常 IncorrectCredentialsException;另外如果密码重试此处太多将抛出超出重试次数异常 ExcessiveAttemptsException;在组装 SimpleAuthenticationInfo 信息时,需要传:身份信息(用户名)、凭据(密文密码)、盐(username+salt),CredentialsMatcher 使用盐加密传入的明文密码和此处的密文密码进行匹配。
2.doGetAuthorizationInfo 获取授权信息:PrincipalCollection 是一个身份集合,因为我们现在就一个 Realm,所以直接调用 getPrimaryPrincipal 得到之前传入的用户名即可;然后根据用户名调用 UserService 接口获取角色及权限信息。
我们这里没有写权限,所以不存在权限验证,我在这里给他拟定了个测试的数据,不影响我们的登录,下面实现了doGetAuthorizationInfo
方法,结合上边对方法的讲解,相信大家可以看懂。
@Override protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principalCollection) { SimpleAuthorizationInfo authorizationInfo = new SimpleAuthorizationInfo(); User user = (User) principalCollection.getPrimaryPrincipal(); //模拟数据库查询出来的用户角色对应的权限 String rolePermission = "/admin"; authorizationInfo.addStringPermission(rolePermission); return authorizationInfo; }
另一个doGetAuthenticationInfo
方法
@Override protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken authenticationToken) throws AuthenticationException { System.out.println("进行身份认证中..."); //获取输入的账号 String userName = (String) authenticationToken.getPrincipal(); //获取输入的密码 //shiro会把密码转为字符,所以这里需要把字符转字符串 String password = new String((char[]) authenticationToken.getCredentials()); //通过userName从数据库中查找 User对象 User user = userService.getUserByUserName(userName); String s = MD5Util.MD5(password); if (user == null || !user.getPassWord().equals(s)) { throw new AccountException("用户名或密码不正确"); } SimpleAuthenticationInfo authenticationInfo = new SimpleAuthenticationInfo( user.getUserName(), user.getPassWord(), null, getName() ); return authenticationInfo; }
这个地方有几点要说一下的:
- 1.shiro会把密码转为字符,所以这里需要把字符转字符串。
String password = new String((char[]) authenticationToken.getCredentials());
- 2.密码比较,我们数据库存储的密码为MD5加密的,我们在核对前端传入的密码时也要加密判断。
String s = MD5Util.MD5(password); if (user == null || !user.getPassWord().equals(s)) { throw new AccountException("用户名或密码不正确"); }
- 3.最后组装 SimpleAuthenticationInfo
SimpleAuthenticationInfo authenticationInfo = new SimpleAuthenticationInfo( user.getUserName(), user.getPassWord(), null, getName() );
3.2、ShiroConfiguration.java
我们新建一个shiro的配置类,这个配置类要和我们的启动类在同一个层中。
接下来进行配置
package com.blog.personalblog; import com.blog.personalblog.shiro.MyShiroRealm; import org.apache.shiro.authc.credential.HashedCredentialsMatcher; import org.apache.shiro.mgt.SecurityManager; import org.apache.shiro.spring.security.interceptor.AuthorizationAttributeSourceAdvisor; import org.apache.shiro.spring.web.ShiroFilterFactoryBean; import org.apache.shiro.web.mgt.DefaultWebSecurityManager; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import java.util.LinkedHashMap; import java.util.Map; /** * @author: SuperMan * @create: 2022-03-14 **/ @Configuration public class ShiroConfiguration { /** * 配置过滤规则 * */ @Bean public ShiroFilterFactoryBean shirFilter(SecurityManager securityManager) { System.out.println("ShiroConfiguration.shirFilter()"); ShiroFilterFactoryBean shiroFilterFactoryBean = new ShiroFilterFactoryBean(); shiroFilterFactoryBean.setSecurityManager(securityManager); //拦截器 Map<String, String> filterChainDefinitionMap = new LinkedHashMap<>(); filterChainDefinitionMap.put("/user/logout", "logout"); // 配置不会被拦截的链接 顺序判断 filterChainDefinitionMap.put("/static/**", "anon"); filterChainDefinitionMap.put("/user/login", "anon"); filterChainDefinitionMap.put("/user/info", "anon"); filterChainDefinitionMap.put("/**", "authc"); //配置shiro默认登录界面地址,前后端分离中登录界面跳转应由前端路由控制,后台仅返回json数据 filterChainDefinitionMap.put("/user/unauth", "anon"); shiroFilterFactoryBean.setFilterChainDefinitionMap(filterChainDefinitionMap); return shiroFilterFactoryBean; } /** * 凭证匹配器 * (由于我们的密码校验交给Shiro的SimpleAuthenticationInfo进行处理了 * ) * * @return */ @Bean public HashedCredentialsMatcher hashedCredentialsMatcher() { HashedCredentialsMatcher hashedCredentialsMatcher = new HashedCredentialsMatcher(); //散列算法:这里使用MD5算法; hashedCredentialsMatcher.setHashAlgorithmName("md5"); //散列的次数,比如散列两次,相当于 md5(md5("")); hashedCredentialsMatcher.setHashIterations(1); return hashedCredentialsMatcher; } /** * 创建 Realm * @Bean 的作用: 将该方法返回的对象放入spring容器 */ @Bean public MyShiroRealm myShiroRealm() { MyShiroRealm myShiroRealm = new MyShiroRealm(); myShiroRealm.setCredentialsMatcher(hashedCredentialsMatcher()); return myShiroRealm; } @Bean public SecurityManager securityManager() { DefaultWebSecurityManager securityManager = new DefaultWebSecurityManager(); securityManager.setRealm(myShiroRealm()); return securityManager; } /** * 开启aop注解支持 * @param securityManager * @return */ @Bean public AuthorizationAttributeSourceAdvisor authorizationAttributeSourceAdvisor(SecurityManager securityManager) { AuthorizationAttributeSourceAdvisor authorizationAttributeSourceAdvisor = new AuthorizationAttributeSourceAdvisor(); authorizationAttributeSourceAdvisor.setSecurityManager(securityManager); return authorizationAttributeSourceAdvisor; } }
- 配置完成后,接下来我们开始写我们的登录接口的功能,打开
UserController.java
,我们原来写好的两个接口,现在补充完整。
我们先创建一个错误码类,用来统一规范我们返回的错误信息。使用枚举类。
package com.blog.personalblog.entity; /** * 错误码 * @author: SuperMan * @create: 2022-03-14 **/ public enum ErrorCode { SUCCESS("成功", 200), NOT_LOGIN("未登录", 100), ERROR_CODE("未定义错误", 101), USER_NOT_EXIST("用户不存在", 102); private int code; private String msg; private ErrorCode(String msg,int code){ this.code = code; this.msg = msg; } public int getCode() { return code; } public String getMsg() { return msg; } }
3.3、登录接口login
然后,我们的login方法:
/** * 登录 * @param loginModel * @return */ @PostMapping("/login") public JsonResult<Object> login(@RequestBody LoginModel loginModel){ logger.info("{} 在请求登录! ", loginModel.getUsername()); Subject subject = SecurityUtils.getSubject(); UsernamePasswordToken token = new UsernamePasswordToken(loginModel.getUsername(), loginModel.getPassword(), false); try { subject.login(token); Map<String, Object> ret = new HashedMap(); ret.put("token", subject.getSession().getId()); logger.info("{} login success", loginModel.getUsername()); return JsonResult.success(ret); } catch (IncorrectCredentialsException e) { logger.info("login fail {}", e.getMessage()); return JsonResult.error(ErrorCode.NOT_LOGIN); } catch (LockedAccountException e) { logger.info("login fail {}", e.getMessage()); return JsonResult.error(ErrorCode.ERROR_CODE); } catch (AuthenticationException e) { logger.info("login fail {}", e.getMessage()); return JsonResult.error(ErrorCode.USER_NOT_EXIST); } catch (Exception e) { e.printStackTrace(); logger.info("login fail {}", e.getMessage()); return JsonResult.error(ErrorCode.ERROR_CODE); } }
- 下面将上边的代码拆解一下。
(1)这一句是获得当前用户到登录对象,现在状态为未认证。
Subject subject = SecurityUtils.getSubject();
- (2)这个是获得用户名密码令牌
UsernamePasswordToken token = new UsernamePasswordToken(loginModel.getUsername(), loginModel.getPassword(), false);
- (3)shiro 使用异常捕捉登录失败消息,然后将令牌传到shiro提供的login方法验证,需要自定义realm。
try { subject.login(token); Map<String, Object> ret = new HashedMap(); ret.put("token", subject.getSession().getId()); logger.info("{} login success", loginModel.getUsername()); return JsonResult.success(ret); } catch (IncorrectCredentialsException e) { logger.info("login fail {}", e.getMessage()); return JsonResult.error(ErrorCode.NOT_LOGIN); }
- 我们在上一篇分析前端登录的时候说过,login接口后边还带了token,我们在登录验证后,再将token返回给前端。
Map<String, Object> ret = new HashedMap(); ret.put("token", subject.getSession().getId()); logger.info("{} login success", loginModel.getUsername()); return JsonResult.success(ret);
3.4、登录info接口
我们写完登录,然后前端还需要一个info接口,我们将info接口补充完整。
/** * 登录info信息 * @return */ @GetMapping("/info") public JsonResult<Object> info(){ Map<String, Object> ret = new HashMap<>(3); ret.put("roles", "[admin]"); ret.put("name", "admin"); ret.put("avatar","https://wpimg.wallstcn.com/f778738c-e4f8-4870-b634-56703b4acafe.gif"); return JsonResult.success(ret); }
- 这个就是返回了一个Map,这个地方数据写死的,本来可以展示用户名的,我再shiro配置的时候不给info加验证就获取不到用户名,加了验证就会出现重定向到错误接口,所以为了简单我就直接写死了,想搞的可以自己看一下,我就不实现了。
还有两个接口,一个是退出的,还有一个登录地址错误的直接重定向到这个接口,看一下就可以了。
@PostMapping("/logout") public JsonResult<Object> logout(){ Subject subject =SecurityUtils.getSubject(); subject.logout(); return JsonResult.success("成功登出"); } @RequestMapping("/unauth") public JsonResult<Object> unauth(){ return JsonResult.error(ErrorCode.NOT_LOGIN); }
- 好啦,基本上登录的流程都写完了,对了,还有一个跨域需要处理,我们配置一下全局跨域的问题。