菜鸟-手把手教你把Acegi应用到实际项目中(8)-扩展UserDetailsService接口

一个能为DaoAuthenticationProvider提供存取认证库的的类，它必须要实现UserDetailsService接口：

Java代码
public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException, DataAccessException;

public UserDetails loadUserByUsername(String username) throws UsernameNotFoundException, DataAccessException;


UserDetails 是一个接口，它能提供一系列get函数以获得认证时需要的基本认证信息如用户名、密码、所获得的授权、是否禁用等；一个具体的实现就是User类. Acegi用户需要决定什么时候写他们的UserDetailsService接口以及返回的UserDetails是什么类型。在大多数情况下将使用 User及其子类，虽然在特定的环境中（如对象关系映射器）也许需要用户写他们自己的UserDetails实现。UserDetails也经常用于存储一些与调用者相关的附加信息（如电话号码、email地址等）因此它们经常在web视图中使用。

如果UserDetailsService实现起来很简单，用户应当很容易从他们选择的持久化策略中找回认证信息。

DaoAuthenticationProvider设计没有考虑支持帐户锁定的功能，因为那将增加UserDetailsService接口的复杂性。例如需要增加不成功认证的计数，这些功能可能通过补充应用程序的公布特性而很容易提供。



1、前面几节我们采用的是Acegi自带的两个类，即UserDetailsService接口的两个实现类JdbcDaoImpl和InMemoryDaoImpl，配置如下：
InMemoryDaoImpl：


Xml代码
<bean id="daoAuthenticationProvider"
class="org.acegisecurity.providers.dao.DaoAuthenticationProvider">
<property name="userDetailsService" ref="inMemDaoImpl" />
</bean>
<bean id="inMemDaoImpl"
class="org.acegisecurity.userdetails.memory.InMemoryDaoImpl">
<property name="userMap">
<value>
javaee=password,ROLE_SUPERVISOR
</value>
</property>
</bean>

<bean id="daoAuthenticationProvider"
class="org.acegisecurity.providers.dao.DaoAuthenticationProvider">
<property name="userDetailsService" ref="inMemDaoImpl" />
</bean>
<bean id="inMemDaoImpl"
class="org.acegisecurity.userdetails.memory.InMemoryDaoImpl">
<property name="userMap">
<value>
javaee=password,ROLE_SUPERVISOR
</value>
</property>
</bean>


JdbcDaoImpl：


Java代码
<bean id="daoAuthenticationProvider"
class="org.acegisecurity.providers.dao.DaoAuthenticationProvider">
<property name="userDetailsService" ref="jdbcDaoImpl" />
</bean>
<bean id="jdbcDaoImpl"
class="org.acegisecurity.userdetails.jdbc.JdbcDaoImpl">
<property name="dataSource">
<ref bean="dataSource" />
</property>
</bean>

<bean id="daoAuthenticationProvider"
class="org.acegisecurity.providers.dao.DaoAuthenticationProvider">
<property name="userDetailsService" ref="jdbcDaoImpl" />
</bean>
<bean id="jdbcDaoImpl"
class="org.acegisecurity.userdetails.jdbc.JdbcDaoImpl">
<property name="dataSource">
<ref bean="dataSource" />
</property>
</bean>




2、自己提供UserDetailsService接口的实现类
当Acegi所提供的实现机制无法满足实际企业应用时，我们往往会扩展Acegi现有的资源以弥补不足之处。同样，如果UserDetailsService接口的两个实现类JdbcDaoImpl和InMemoryDaoImpl已经满足不了我们的需求，那么此时提供自己的实现类以满足现实需求是非常有必要的。
一般实现步骤：
1）实现UserDetails接口：




Java代码
public interface UserDetails extends Serializable {
public abstract GrantedAuthority[] getAuthorities(); // 获取用户的授权信息

public abstract String getPassword(); // 获取用户密码(凭证)

public abstract String getUsername(); // 获取用户名

public abstract boolean isAccountNonExpired(); // 判断帐号是否已经过期

public abstract boolean isAccountNonLocked(); // 判断帐号是否已被锁定

public abstract boolean isCredentialsNonExpired(); // 判断用户凭证是否已经过期

public abstract boolean isEnabled(); // 判断用户帐号是否已启用
}

public interface UserDetails extends Serializable {
public abstract GrantedAuthority[] getAuthorities(); // 获取用户的授权信息

public abstract String getPassword(); // 获取用户密码(凭证)

public abstract String getUsername(); // 获取用户名

public abstract boolean isAccountNonExpired(); // 判断帐号是否已经过期

public abstract boolean isAccountNonLocked(); // 判断帐号是否已被锁定

public abstract boolean isCredentialsNonExpired(); // 判断用户凭证是否已经过期

public abstract boolean isEnabled(); // 判断用户帐号是否已启用
}
如果帐号过期、被锁定、凭证过期或帐号未启用，均不能登录到系统中。


本例提供的实现类：

Java代码
public class UserLoginDetails implements UserDetails {

private String username;
private String password;
private boolean enabled;
private GrantedAuthority[] authorities;

public void setAuthorities(GrantedAuthority[] authorities) {
this.authorities = authorities;
}

public void setEnabled(boolean enabled) {
this.enabled = enabled;
}

public void setPassword(String password) {
this.password = password;
}

public void setUsername(String username) {
this.username = username;
}

public GrantedAuthority[] getAuthorities() {
return authorities;
}

public String getPassword() {
return password;
}

public String getUsername() {
return username;
}

public boolean isAccountNonExpired() {
return enabled;
}

public boolean isAccountNonLocked() {
return enabled;
}

public boolean isCredentialsNonExpired() {
return enabled;
}

public boolean isEnabled() {
return enabled;
}

}

public class UserLoginDetails implements UserDetails {

private String username;
private String password;
private boolean enabled;
private GrantedAuthority[] authorities;

public void setAuthorities(GrantedAuthority[] authorities) {
this.authorities = authorities;
}

public void setEnabled(boolean enabled) {
this.enabled = enabled;
}

public void setPassword(String password) {
this.password = password;
}

public void setUsername(String username) {
this.username = username;
}

public GrantedAuthority[] getAuthorities() {
return authorities;
}

public String getPassword() {
return password;
}

public String getUsername() {
return username;
}

public boolean isAccountNonExpired() {
return enabled;
}

public boolean isAccountNonLocked() {
return enabled;
}

public boolean isCredentialsNonExpired() {
return enabled;
}

public boolean isEnabled() {
return enabled;
}

}


2）实现UserDetailsService接口：



Java代码
public interface UserDetailsService {
public abstract UserDetails loadUserByUsername(String s)
throws UsernameNotFoundException, DataAccessException;
}

public interface UserDetailsService {
public abstract UserDetails loadUserByUsername(String s)
throws UsernameNotFoundException, DataAccessException;
}


本例提供的实现类为:

Java代码
public class UserLoginServiceImpl implements UserDetailsService {

// 根据用户名返回用户信息
public UserDetails loadUserByUsername(String username)
throws UsernameNotFoundException, DataAccessException {
// 以下两行是获取用户信息，UserLogin是存放用户信息的业务实体
BaseDaoImpl baseDao = new BaseDaoImpl();
UserLogin userLogin = baseDao.getUserInfo(username);

UserLoginDetails userDetails = new UserLoginDetails();
if (userLogin != null) { // 如果该用户的信息存在，那么构造UserDetails
userDetails.setUsername(userLogin.getUsername()); // 设置用户名
userDetails.setPassword(userLogin.getPassword()); // 设置密码
userDetails.setEnabled(userLogin.isEnabled()); // 设置启用状态

// 角色字符串如：”ROLE_SUPERVISOR，ROLE_USER”。以逗号隔开
String[] rights = userLogin.getRights().split(","); // 分割多个角色
// 设置用户的授权信息
GrantedAuthority[] authorities = new GrantedAuthority[rights.length]; for (int i = 0; i < rights.length; i++) {
authorities[i] = new GrantedAuthorityImpl(rights[i]);
}
userDetails.setAuthorities(authorities);
} else { // 如果该用户不存在，则抛出异常，参考JdbcDaoImpl
throw new UsernameNotFoundException("User not found");
}

return userDetails;
}

}

public class UserLoginServiceImpl implements UserDetailsService {

// 根据用户名返回用户信息
public UserDetails loadUserByUsername(String username)
throws UsernameNotFoundException, DataAccessException {
// 以下两行是获取用户信息，UserLogin是存放用户信息的业务实体
BaseDaoImpl baseDao = new BaseDaoImpl();
UserLogin userLogin = baseDao.getUserInfo(username);

UserLoginDetails userDetails = new UserLoginDetails();
if (userLogin != null) { // 如果该用户的信息存在，那么构造UserDetails
userDetails.setUsername(userLogin.getUsername()); // 设置用户名
userDetails.setPassword(userLogin.getPassword()); // 设置密码
userDetails.setEnabled(userLogin.isEnabled()); // 设置启用状态

// 角色字符串如：”ROLE_SUPERVISOR，ROLE_USER”。以逗号隔开
String[] rights = userLogin.getRights().split(","); // 分割多个角色
// 设置用户的授权信息
GrantedAuthority[] authorities = new GrantedAuthority[rights.length]; for (int i = 0; i < rights.length; i++) {
authorities[i] = new GrantedAuthorityImpl(rights[i]);
}
userDetails.setAuthorities(authorities);
} else { // 如果该用户不存在，则抛出异常，参考JdbcDaoImpl
throw new UsernameNotFoundException("User not found");
}

return userDetails;
}

}


UserLogin类：

Java代码
public class UserLogin {
private String username; // 用户名

private String password; // 密码

private boolean enabled; // 启用状态

private String rights; // 多个角色组成的字符串
...... // 省略get,set方法
}

public class UserLogin {
private String username; // 用户名

private String password; // 密码

private boolean enabled; // 启用状态

private String rights; // 多个角色组成的字符串
...... // 省略get,set方法
}


3）将自己的实现类注入到DaoAuthenticationProvider的userDetailsService属性中。



Xml代码
<bean id="daoAuthenticationProvider" class="org.acegisecurity.providers.dao.DaoAuthenticationProvider">
<property name="userDetailsService" ref="userLoginServiceImpl"/>
......
</bean>
<!-- 自己实现的类 -->
<bean id="userLoginServiceImpl" class="org.acegi.service.impl.UserLoginServiceImpl"></bean>

<bean id="daoAuthenticationProvider" class="org.acegisecurity.providers.dao.DaoAuthenticationProvider">
<property name="userDetailsService" ref="userLoginServiceImpl"/>
......
</bean>
<!-- 自己实现的类 -->
<bean id="userLoginServiceImpl" class="org.acegi.service.impl.UserLoginServiceImpl"></bean>





3、运行说明
下载源代码，我提供了相应脚本，存放在Acegi7WebRoot\rdbms目录下。
1）、在rdbms目录下运行server.bat文件，启动hsqldb数据库。关于hsqldb的使用说明，请参考“菜鸟-手把手教你把Acegi应用到实际项目中(6)” http://zhanjia.iteye.com/blog/258282
2）、运行Acegi7项目
3）、用户名为javaee、qiuzj，密码为password


4、其他说明
开发环境：
MyEclipse 5.0GA
Eclipse3.2.1
JDK1.5.0_10
tomcat5.5.23
acegi-security-1.0.7
Spring2.0


Jar包：
acegi-security-1.0.7.jar
Spring.jar(2.0.8)
commons-codec.jar
jstl.jar (1.1)
standard.jar
commons-logging.jar(1.0)
hsqldb.jar(1.8.0.10)