Struts2入门第十二讲——使用Struts2完成用户登录的权限拦截器的代码编写

蔚落 2024-04-17 18:28 27阅读 0赞

本讲是和[《Struts2入门第九讲——优化CRM系统中客户列表显示的功能》][Struts2_CRM]这一讲一脉相承的，如果有小伙伴没看过这一讲，那么你在阅读本讲的过程中，将一直都是懵逼状态。

# 需求概述 #

在CRM的系统中，有用户登录的功能，如果访问者知道了后台的访问页面的路径，有可能没有进行登录直接就进入到了CRM系统中，那么对于这类的账号就需要进行拦截。首先肯定是需要实现用户登录这个功能的，如果对于没有登录的用户直接访问后台的Action，那么就需要对其实施拦截，要让其登录成功之后再来访问。

# 环境搭建 #

由于环境在Struts2入门第二讲中就已经搭建好了，所以这儿就不费笔墨了。下面只须编写代码实现该以上需求就OK了。

# 案例代码实现 #

## 实现用户登录的功能 ##

### 创建用户表 ###

在struts2\_crm数据库下新建一张用户表，这里笔者使用的数据库是MySQL。

CREATE TABLE `sys_user` (
    	`user_id` bigint(32) NOT NULL AUTO_INCREMENT COMMENT '用户id',
    	`user_code` varchar(32) NOT NULL COMMENT '用户账号',
    	`user_name` varchar(64) NOT NULL COMMENT '用户名称',
    	`user_password` varchar(32) NOT NULL COMMENT '用户密码',
    	`user_state` char(1) NOT NULL COMMENT '1:正常,0:暂停',
    	PRIMARY KEY (`user_id`)
    ) ENGINE=InnoDB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8;

### 编写User实体类及其相对应的映射配置文件 ###

在com.meimeixia.domain包下创建一个User实体类及其相对应的映射配置文件。

*  User实体类
    
        package com.meimeixia.domain;
        
        /** * 用户模块的实体 * @author liayun * */
        public class User { 
        
        	private Long user_id;
        	private String user_code;
        	private String user_name;
        	private String user_password;
        	private String user_state;
        	public Long getUser_id() { 
        		return user_id;
        	}
        	public void setUser_id(Long user_id) { 
        		this.user_id = user_id;
        	}
        	public String getUser_code() { 
        		return user_code;
        	}
        	public void setUser_code(String user_code) { 
        		this.user_code = user_code;
        	}
        	public String getUser_name() { 
        		return user_name;
        	}
        	public void setUser_name(String user_name) { 
        		this.user_name = user_name;
        	}
        	public String getUser_password() { 
        		return user_password;
        	}
        	public void setUser_password(String user_password) { 
        		this.user_password = user_password;
        	}
        	public String getUser_state() { 
        		return user_state;
        	}
        	public void setUser_state(String user_state) { 
        		this.user_state = user_state;
        	}
        	@Override
        	public String toString() { 
        		return "User [user_id=" + user_id + ", user_code=" + user_code + ", user_name=" + user_name + ", user_password="
        				+ user_password + ", user_state=" + user_state + "]";
        	}
        	
        }
 *  User.hbm.xml
    
        <?xml version="1.0" encoding="UTF-8"?>
        <!DOCTYPE hibernate-mapping PUBLIC "-//Hibernate/Hibernate Mapping DTD 3.0//EN" "http://www.hibernate.org/dtd/hibernate-mapping-3.0.dtd">
            
        <hibernate-mapping>
        	
        	<class name="com.meimeixia.domain.User" table="sys_user">
        		
        		<id name="user_id" column="user_id">
        			
        			<generator class="native" />
        		</id>
        		
        		
        		<property name="user_code" column="user_code" />
        		<property name="user_name" column="user_name" />
        		<property name="user_password" column="user_password" />
        		<property name="user_state" column="user_state" />
        	</class>
        </hibernate-mapping>
    
    温馨提示：记得在Hibernate的核心配置文件（hibernate.cfg.xml）中引入以上映射配置文件哟！  
    ![在这里插入图片描述][20190829205926109.png]

### 修改登录的页面 ###

为了实现用户登录这个功能，我们首先就应该要修改登录的页面（login.jsp），下面也只是第一次修改，后续还有几次修改。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70]

### 编写web层 ###

在com.meimeixia.web.action包下创建一个UserAction类，并在里面写一个用户登录的方法。

package com.meimeixia.web.action;
    
    import org.apache.struts2.ServletActionContext;
    
    import com.meimeixia.domain.User;
    import com.meimeixia.service.UserService;
    import com.meimeixia.service.impl.UserServiceImpl;
    import com.opensymphony.xwork2.ActionContext;
    import com.opensymphony.xwork2.ActionSupport;
    import com.opensymphony.xwork2.ModelDriven;
    
    /** * 用户的Action的类 * @author liayun * */
    public class UserAction extends ActionSupport implements ModelDriven<User> { 
    	
    	//接收数据
    	private User user = new User();
    	
    	@Override
    	public User getModel() { 
    		return user;
    	}
    
    	/* * 用户登录的方法 */
    	public String login() { 
    // System.out.println(user);
    		//调用业务层
    		UserService userService = new UserServiceImpl();
    		User existUser = userService.login(user);
    		//根据结果进行页面跳转
    		if (existUser == null) { 
    			//登录失败
    			/* * 向页面传递信息的时候，可以使用ActionError、FieldError、ActionMessage * 1. ActionError：主要是说的一些错误信息 * 2. FieldError：主要是说的一些错误信息，但它只针对某一个字段 * 3. ActionMessage：主要是说的一些普通信息 */
    			this.addActionError("用户名或者密码错误！");
    			return LOGIN;
    		} else { 
    			//登录成功
    // ActionContext.getContext().getSession().put("existUser", existUser);
    			//或者
    			ServletActionContext.getRequest().getSession().setAttribute("existUser", existUser);
    			return SUCCESS;
    		}
    	}
    
    }

### 编写service层 ###

首先，我们在com.meimeixia.service包下创建一个UserService接口，该接口的具体代码如下：

package com.meimeixia.service;
    
    import com.meimeixia.domain.User;
    
    /** * 用户业务层的接口 * @author liayun * */
    public interface UserService { 
    
    	User login(User user);
    
    }

然后，在com.meimeixia.service.impl包下编写UserService接口的一个实现类——UserServiceImpl.java。

package com.meimeixia.service.impl;
    
    import com.meimeixia.dao.UserDao;
    import com.meimeixia.dao.impl.UserDaoImpl;
    import com.meimeixia.domain.User;
    import com.meimeixia.service.UserService;
    
    /** * 用户的业务层的实现类 * @author liayun * */
    public class UserServiceImpl implements UserService { 
    
    	/* * 业务层中用户登录的方法 */
    	@Override
    	public User login(User user) { 
    		UserDao userDao = new UserDaoImpl();
    		return userDao.login(user);
    	}
    
    }

### 编写dao层 ###

首先，在com.meimeixia.dao包下创建一个UserDao接口，该接口的具体代码如下：

package com.meimeixia.dao;
    
    import com.meimeixia.domain.User;
    
    /** * 用户的Dao的接口 * @author liayun * */
    public interface UserDao { 
    
    	User login(User user);
    	
    }

然后，在com.meimeixia.dao.impl包下编写UserDao接口的一个实现类——UserDaoImpl.java。

package com.meimeixia.dao.impl;
    
    import java.util.List;
    
    import org.hibernate.Query;
    import org.hibernate.Session;
    import org.hibernate.Transaction;
    
    import com.meimeixia.dao.UserDao;
    import com.meimeixia.domain.User;
    import com.meimeixia.utils.HibernateUtils;
    
    /** * 用户的Dao的实现类 * @author liayun * */
    public class UserDaoImpl implements UserDao { 
    
    	/* * 用户登录的方法 */
    	@Override
    	public User login(User user) { 
    		Session session = HibernateUtils.getCurrentSession();
    		Transaction tx = session.beginTransaction();
    		
    		Query query = session.createQuery("from User where user_code = ? and user_password = ?");
    		//设置参数
    		query.setParameter(0, user.getUser_code());
    		query.setParameter(1, user.getUser_password());
    // User existUser = (User) query.uniqueResult();//返回的是一个对象，故可直接使用uniqueResult方法
    		List<User> list = query.list();
    		if (list.size() > 0) { 
    			return list.get(0);
    		}
    		
    		tx.commit();
    		
    		return null;
    	}
    
    }

### 配置Action ###

在struts.xml文件中配置上自己编写的UserAction类，就像下面这样：

<?xml version="1.0" encoding="UTF-8" ?>
    <!DOCTYPE struts PUBLIC "-//Apache Software Foundation//DTD Struts Configuration 2.3//EN" "http://struts.apache.org/dtds/struts-2.3.dtd">
    
    <struts>
    	
    	<constant name="struts.action.extension" value="action" />
    
    	<package name="crm" extends="struts-default" namespace="/">
    		<action name="customer_*" class="com.meimeixia.web.action.CustomerAction" method="{1}">
    			<result name="findSuccess">/jsp/customer/list.jsp</result>
    			<result name="saveUI">/jsp/customer/add.jsp</result>
    			<result name="saveSuccess" type="redirectAction">customer_find.action</result>
    		</action>
    		
    		<action name="user_*" class="com.meimeixia.web.action.UserAction" method="{1}">
    			<result name="success" type="redirect">/index.jsp</result>
    			<result name="login">/login.jsp</result>
    		</action>
    	</package>
    </struts>

当用户登录失败后，肯定是要跳回到登录页面让其再登录的，那就必然会带一些错误信息（比如什么用户名或者密码错误啊之类的信息）到登录页面，咋带呢？在UserAction类中我已经写的很清楚了，那么问题来了，在登录页面中我们要如何显示这些带过来的错误信息呢？使用`<s:actionerror/>`标签就能显示啦！所以，咱还需要修改登录页面，修改成下面这样。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 1]  
当用户登录成功后，用户的实例对象就存储在了session域中了，从以上struts.xml文件中UserAction的配置可知，用户登录成功以后还得重定向到项目的首页中，咱还得在项目的首页中获取到用户的一些相关信息，比如用户名之类的，所以，咱还得修改一下首页中包含的top.jsp页面。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 2]

### 测试登录功能 ###

发布我们的项目到Tomcat服务器并启动，然后访问该项目的login.jsp页面，输入登录名和登录密码，测试的效果如下图所示。  
![在这里插入图片描述][20190830103238578.gif]

## 实现权限拦截器 ##

### 编写登录权限拦截器 ###

在src目录下创建一个在com.meimeixia.web.interceptor包，并在该包下新建一个登录权限拦截器。

package com.meimeixia.web.interceptor;
    
    import org.apache.struts2.ServletActionContext;
    
    import com.meimeixia.domain.User;
    import com.opensymphony.xwork2.ActionInvocation;
    import com.opensymphony.xwork2.ActionSupport;
    import com.opensymphony.xwork2.interceptor.MethodFilterInterceptor;
    
    /** * 登录权限拦截器 * @author liayun * */
    public class PrivilegeInterceptor extends MethodFilterInterceptor { 
    
    	@Override
    	protected String doIntercept(ActionInvocation invocation) throws Exception { 
    		//判断session中是否存在用户数据
    		User existUser = (User) ServletActionContext.getRequest().getSession().getAttribute("existUser");
    		//判断从session中来获取的用户的信息是否为空
    		if (existUser == null) { 
    			//没有登录，
    			//给出提示信息
    			/* * invocation：Struts2框架底层真正干活的对象，它谁都能获得到 * getAction()方法就能获得正在执行或正在访问的那个Action，如果你登录的话，获得的就是UserAction，如果你现在正在做客户列表的查询的话， * 获得的就是CustomerAction。 */
    			ActionSupport actionSupport = (ActionSupport) invocation.getAction();
    			actionSupport.addActionError("您没有登录！您没有权限访问！");
    			
    			//让它回到登录页面
    			return actionSupport.LOGIN;
    		} else { 
    			//已经登录，则放行
    			return invocation.invoke();
    		}
    	}
    
    }

温馨提示：在编写登录权限拦截器时，我们让它继承了MethodFilterInterceptor这个抽象类，一旦我们编写的拦截器继承了这个抽象类，那么它就会对Action中的方法进行拦截，也即更加细粒度的拦截。查看MethodFilterInterceptor这个类的源码，发现它里面有两个属性，如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 3]  
等一下，我们就会在struts.xml文件中配置所编写的登录权限拦截器时，用到excludeMethods这个属性。

### 配置拦截器 ###

在struts.xml文件中配置好上面我们所编写的登录权限拦截器。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 4]

### 测试登录权限拦截器 ###

发布我们的项目到Tomcat服务器并启动，然后访问该项目的首页，测试的效果如下图所示。  
![在这里插入图片描述][20190830111207716.gif]  
发现用户登录成功之后，页面嵌套了，这咋整呢？只须修改登录页面的一个地方，如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 5]  
这个时候，测试的效果就如下图所示了。  
![在这里插入图片描述][20190830111231825.gif]  
至此，登录权限拦截器就算是测试通过了，最后，感谢阅读，希望读者能够看懂，有所疑问可以留言。

[Struts2_CRM]: https://blog.csdn.net/yerenyuan_pku/article/details/99645284
[20190829205926109.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/54de64e7d57548ff9f803291304469ff.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/5ee434cd3e514824ac702e2c1499aa18.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/1dc1021eef584a7a9b496c660c565f2e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/6671e6fbd78b43e78401919bc424339d.png
[20190830103238578.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/c129a2dc0d6f4e40ac02920f0b3dfe3e.gif
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 3]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/111ac56a2ab94b4d91cc6294601d5d44.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 4]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/f4300cbf8d7343d0824226bee88bda5a.png
[20190830111207716.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/2a9dfad3367d44179a9fb91b88a51057.gif
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3llcmVueXVhbl9wa3U_size_16_color_FFFFFF_t_70 5]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/69bf64393d40429eaa75dd89aae07e46.png
[20190830111231825.gif]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/17/38325da5cacb45f0904e7079f70fb335.gif