Java秒殺系統(tǒng)(五):整合Shiro實現(xiàn)用戶登錄認證

作者: 修羅debug
版權(quán)聲明:本文為博主原創(chuàng)文章,遵循 CC 4.0 by-sa 版權(quán)協(xié)議,轉(zhuǎn)載請附上原文出處鏈接和本聲明。



摘要:本篇博文是“Java秒殺系統(tǒng)實戰(zhàn)系列文章”的第五篇,在本篇博文中,我們將整合權(quán)限認證-授權(quán)框架Shiro,實現(xiàn)用戶的登陸認證功能,主要用于:要求用戶在搶購商品或者秒殺商品時,限制用戶進行登陸!并對于特定的url(比如搶購請求對應(yīng)的url)進行過濾(即當(dāng)用戶訪問指定的url時,需要要求用戶進行登陸)。

內(nèi)容:對于Shiro,相信各位小伙伴應(yīng)該聽說過,甚至應(yīng)該也使用過!簡單而言,它是一個很好用的用戶身份認證、權(quán)限授權(quán)框架,可以實現(xiàn)用戶登錄認證,權(quán)限、資源授權(quán)、會話管理等功能,在本秒殺系統(tǒng)中,我們將主要采用該框架實現(xiàn)對用戶身份的認證和用戶的登錄功能。

值得一提的是,本篇博文介紹的“Shiro實現(xiàn)用戶登錄認證”功能模塊涉及到的數(shù)據(jù)庫表為用戶信息表user,下面進入代碼實戰(zhàn)環(huán)節(jié)。

<!--shiro權(quán)限控制-->
<dependency>
<groupId>org.apache.shiro</groupId>
<artifactId>shiro-ehcache</artifactId>
<version>${shiro.version}</version>
</dependency>

<dependency>
<groupId>org.apache.shiro</groupId>
<artifactId>shiro-core</artifactId>
<version>${shiro.version}</version>
</dependency>

<dependency>
<groupId>org.apache.shiro</groupId>
<artifactId>shiro-web</artifactId>
<version>${shiro.version}</version>
</dependency>

<dependency>
<groupId>org.apache.shiro</groupId>
<artifactId>shiro-spring</artifactId>
<version>${shiro.version}</version>
</dependency>

(2) 緊接著是在UserController控制器中開發(fā)用戶前往登錄、用戶登錄以及用戶退出登錄的請求對應(yīng)的功能方法,其完整的源代碼如下所示:  

@Autowired
private Environment env;

//跳到登錄頁
@RequestMapping(value = {"/to/login","/unauth"})
public String toLogin(){
return "login";
}

//登錄認證
@RequestMapping(value = "/login",method = RequestMethod.POST)
public String login(@RequestParam String userName, @RequestParam String password, ModelMap modelMap){
String errorMsg="";
try {
if (!SecurityUtils.getSubject().isAuthenticated()){
String newPsd=new Md5Hash(password,env.getProperty("shiro.encrypt.password.salt")).toString();
UsernamePasswordToken token=new UsernamePasswordToken(userName,newPsd);
SecurityUtils.getSubject().login(token);
}
}catch (UnknownAccountException e){
errorMsg=e.getMessage();
modelMap.addAttribute("userName",userName);
}catch (DisabledAccountException e){
errorMsg=e.getMessage();
modelMap.addAttribute("userName",userName);
}catch (IncorrectCredentialsException e){
errorMsg=e.getMessage();
modelMap.addAttribute("userName",userName);
}catch (Exception e){
errorMsg="用戶登錄異常,請聯(lián)系管理員!";
e.printStackTrace();
}
if (StringUtils.isBlank(errorMsg)){
return "redirect:/index";
}else{
modelMap.addAttribute("errorMsg",errorMsg);
return "login";
}
}

//退出登錄
@RequestMapping(value = "/logout")
public String logout(){
SecurityUtils.getSubject().logout();
return "login";
}

其中,在匹配用戶的密碼時,我們在這里采用的Md5Hash的方法,即MD5加密的方式進行匹配(因為數(shù)據(jù)庫的user表中用戶的密碼字段存儲的正是采用MD5加密后的加密串)

前端頁面login.jsp的內(nèi)容比較簡單,只需要用戶輸入最基本的用戶名和密碼即可,如下圖所示為該頁面的部分核心源代碼:  



當(dāng)前端提交“用戶登錄”請求時,將以“提交表單”的形式將用戶名、密碼提交到后端UserController控制器對應(yīng)的登錄方法中,該方法首先會進行最基本的參數(shù)判斷與校驗,校驗通過之后,會調(diào)用Shiro內(nèi)置的組件SecurityUtils.getSubject().login()方法執(zhí)行登錄操作,其中的登錄操作將主要在 “自定義的Realm的doGetAuthenticationInfo方法”中執(zhí)行。

(4) 接下來是基于Shiro的AuthorizingRealm,開發(fā)自定義的Realm,并實現(xiàn)其中的用戶登錄認證方法,即doGetAuthenticationInfo()方法。其完整的源代碼如下所示:  

/**
* 用戶自定義的realm-用于shiro的認證、授權(quán)
* @Author:debug (SteadyJack)
* @Date: 2019/7/2 17:55
**/
public class CustomRealm extends AuthorizingRealm{
private static final Logger log= LoggerFactory.getLogger(CustomRealm.class);

private static final Long sessionKeyTimeOut=3600_000L;
@Autowired
private UserMapper userMapper;

//授權(quán)
@Override
protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principalCollection) {
return null;
}

//認證-登錄
@Override
protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken authenticationToken) throws AuthenticationException {
UsernamePasswordToken token= (UsernamePasswordToken) authenticationToken;
String userName=token.getUsername();
String password=String.valueOf(token.getPassword());
log.info("當(dāng)前登錄的用戶名={} 密碼={} ",userName,password);

User user=userMapper.selectByUserName(userName);
if (user==null){
throw new UnknownAccountException("用戶名不存在!");
}
if (!Objects.equals(1,user.getIsActive().intValue())){
throw new DisabledAccountException("當(dāng)前用戶已被禁用!");
}
if (!user.getPassword().equals(password)){
throw new IncorrectCredentialsException("用戶名密碼不匹配!");
}

SimpleAuthenticationInfo info=new SimpleAuthenticationInfo(user.getUserName(),password,getName());
setSession("uid",user.getId());
return info;
}

/**
* 將key與對應(yīng)的value塞入shiro的session中-最終交給HttpSession進行管理(如果是分布式session配置,那么就是交給redis管理)
* @param key
* @param value
*/
private void setSession(String key,Object value){
Session session=SecurityUtils.getSubject().getSession();
if (session!=null){
session.setAttribute(key,value);
session.setTimeout(sessionKeyTimeOut);
}
}
}

其中,userMapper.selectByUserName(userName);主要用于根據(jù)userName查詢用戶實體信息,其對應(yīng)的動態(tài)Sql的寫法如下所示:    

<!--根據(jù)用戶名查詢-->
<select id="selectByUserName" resultType="com.debug.kill.model.entity.User">
SELECT <include refid="Base_Column_List"/>
FROM user
WHERE user_name = #{userName}
</select>

值得一提的是,當(dāng)用戶登錄成功時(即用戶名和密碼的取值跟數(shù)據(jù)庫的user表相匹配),我們會借助Shiro的Session會話機制將當(dāng)前用戶的信息存儲至服務(wù)器會話中,并緩存一定時間?。ㄔ谶@里是3600s,即1個小時)!


(4) 最后是我們需要實現(xiàn)“用戶在訪問待秒殺商品詳情或者搶購商品或者任何需要進行攔截的業(yè)務(wù)請求時,如何自動檢測用戶是否處于登錄的狀態(tài)?如果已經(jīng)登錄,則直接進入業(yè)務(wù)請求對應(yīng)的方法邏輯,否則,需要前往用戶登錄頁要求用戶進行登錄”。


基于這樣的需求,我們需要借助Shiro的組件ShiroFilterFactoryBean 實現(xiàn)“用戶是否登錄”的判斷,以及借助FilterChainDefinitionMap攔截一些需要授權(quán)的鏈接URL,其完整的源代碼如下所示:  

/**
* shiro的通用化配置
* @Author:debug (SteadyJack)
* @Date: 2019/7/2 17:54
**/
@Configuration
public class ShiroConfig {

@Bean
public CustomRealm customRealm(){
return new CustomRealm();
}

@Bean
public SecurityManager securityManager(){
DefaultWebSecurityManager securityManager=new DefaultWebSecurityManager();
securityManager.setRealm(customRealm());
securityManager.setRememberMeManager(null);
return securityManager;
}

@Bean
public ShiroFilterFactoryBean shiroFilterFactoryBean(){
ShiroFilterFactoryBean bean=new ShiroFilterFactoryBean();
bean.setSecurityManager(securityManager());
bean.setLoginUrl("/to/login");
bean.setUnauthorizedUrl("/unauth");
//對于一些授權(quán)的鏈接URL進行攔截
Map<String, String> filterChainDefinitionMap=new HashMap<>();
filterChainDefinitionMap.put("/to/login","anon");
filterChainDefinitionMap.put("/**","anon");

filterChainDefinitionMap.put("/kill/execute","authc");
filterChainDefinitionMap.put("/item/detail/*","authc");

bean.setFilterChainDefinitionMap(filterChainDefinitionMap);
return bean;
}

}


從上述該源代碼中可以看出,Shiro的ShiroFilterFactoryBean組件將會對 URL=/kill/execute 和 URL=/item/detail/*  的鏈接進行攔截,即當(dāng)用戶訪問這些URL時,系統(tǒng)會要求當(dāng)前的用戶進行登錄(前提是用戶還沒登錄的情況下!如果已經(jīng)登錄,則直接略過,進入實際的業(yè)務(wù)模塊!)

除此之外,Shiro的ShiroFilterFactoryBean組件還設(shè)定了 “前往登錄頁”和“用戶沒授權(quán)/沒登錄的前提下的調(diào)整頁”的鏈接,分別是 /to/login 和 /unauth!

(5) 至此,整合Shiro框架實現(xiàn)用戶的登錄認證的前后端代碼實戰(zhàn)已經(jīng)完畢了,將項目/系統(tǒng)運行在外置的tomcat服務(wù)器中,打開瀏覽器即可訪問進入“待秒殺商品的列表頁”,點擊“詳情”,此時,由于用戶還沒登陸,故而將跳轉(zhuǎn)至用戶登錄頁,如下圖所示:  



輸入用戶名:debug,密碼:123456,點擊“登錄”按鈕,即可登錄成功,并成功進入“詳情頁”,如下圖所示:   


登錄成功之后,再回到剛剛上一個列表頁,即“待秒殺商品的列表頁”,再次點擊“詳情”按鈕,此時會直接進入“待秒殺商品的詳情頁”,而不會跳轉(zhuǎn)至“用戶登錄頁”,而且用戶的登錄態(tài)將會持續(xù)1個小時?。ㄟ@是借助Shiro的Session的來實現(xiàn)的)。  

補充:

1、目前,這一秒殺系統(tǒng)的整體構(gòu)建與代碼實戰(zhàn)已經(jīng)全部完成了,該秒殺系統(tǒng)對應(yīng)的視頻教程的鏈接地址為:https://www.fightjava.com/web/index/course/detail/6,可以點擊鏈接進行試看以及學(xué)習(xí),實戰(zhàn)期間有任何問題都可以留言或者與Debug聯(lián)系、交流!

2、另外,Debug也開源了該秒殺系統(tǒng)對應(yīng)的完整的源代碼以及數(shù)據(jù)庫,其地址可以來這里下載:https://gitee.com/steadyjack/SpringBoot-SecondKill 記得Fork跟Star?。。。?/span>

3、最后,不要忘記了關(guān)注一下Debug的技術(shù)微信公眾號: