org.hswebframework.web.service.authorization

接口 UserService

所有超级接口:

CreateEntityService<UserEntity>, InsertService<UserEntity,String>, QueryByEntityService<UserEntity>, QueryService<UserEntity,String>, Service

public interface UserService
extends CreateEntityService<UserEntity>, QueryByEntityService<UserEntity>, QueryService<UserEntity,String>, InsertService<UserEntity,String>

用户服务,提供对用户信息对常用操作

从以下版本开始:

3.0

作者:

zhouhao

方法概要

限定符和类型	方法和说明
boolean	disable(String userId) 禁用用户
boolean	enable(String userId) 启用用户
String	encodePassword(String password, String salt) 对密码进行加密混淆
List<RoleEntity>	getUserRole(String userId) 获取用户的全部角色信息
String	insert(UserEntity data) 新增用户
List<UserEntity>	selectByUserByRole(List<String> roleIdList) 根据角色id集合获取对应的全部用户
UserEntity	selectByUsername(String username) 根据用户名查询用户信息
UserEntity	selectByUserNameAndPassword(String plainUsername, String plainPassword) 根据用户名和密码查询用户信息，在验证用户名密码是否正确是可以使用此方法
void	update(String userId, UserEntity userBean) 修改用户信息,如果传入对实体实现了BindRoleUserEntity,将更新用户的权限信息,更新逻辑: 删除用户的权限信息,将新的权限信息重新insert,⚠️注意: 如果BindRoleUserEntity.getRoles()等于null,将不更新角色信息.
void	updatePassword(String userId, String oldPassword, String newPassword) 修改用户密码

从接口继承的方法 org.hswebframework.web.service.CreateEntityService

createEntity, getEntityInstanceType

从接口继承的方法 org.hswebframework.web.service.QueryByEntityService

count, select, selectPager, selectSingle

从接口继承的方法 org.hswebframework.web.service.QueryService

count, select, selectByPk, selectByPk

方法详细资料

insert

String insert(UserEntity data)

新增用户

指定者:

insert 在接口中 InsertService<UserEntity,String>

参数:

data - 要添加的数据

返回:

用户id

另请参阅:

UserCreatedEvent, BindRoleUserEntity

enable

boolean enable(String userId)

启用用户

参数:

userId - 用户Id

返回:

是否启用成功

另请参阅:

UserEntity.setStatus(Byte), DataStatus.STATUS_ENABLED

disable

boolean disable(String userId)

禁用用户

参数:

userId - 用户Id

返回:

是否启用成功

另请参阅:

UserEntity.setStatus(Byte), DataStatus.STATUS_DISABLED

update

void update(String userId,
            UserEntity userBean)

修改用户信息,如果传入对实体实现了BindRoleUserEntity,将更新用户的权限信息,更新逻辑:
删除用户的权限信息,将新的权限信息重新insert,⚠️注意: 如果BindRoleUserEntity.getRoles()等于null,将不更新角色信息.
用户信息更新后,将发布事件:UserModifiedEvent,在其他服务可通过监听此事件来 来实现特定的操作,如清空用户权限缓存等.

参数:

userId - 用户ID

userBean - 用户信息实体类

另请参阅:

UserModifiedEvent, org.springframework.context.ApplicationListener, org.springframework.context.event.EventListener, BindRoleUserEntity

selectByUsername

UserEntity selectByUsername(String username)

根据用户名查询用户信息

参数:

username - 用户名,区分大小写,不能为空

返回:

用户信息, 如果不存在则返回 null

selectByUserNameAndPassword

UserEntity selectByUserNameAndPassword(String plainUsername,
                                       String plainPassword)

根据用户名和密码查询用户信息，在验证用户名密码是否正确是可以使用此方法

参数:

plainUsername - 用户名,区分大小写,不能为空

plainPassword - 明文密码,区分大小写,不能为空

返回:

用户信息, 如果用户名或者密码错误, 则返回null

另请参阅:

PasswordEncoder

encodePassword

String encodePassword(String password,
                      String salt)

对密码进行加密混淆

参数:

password - 明文密码,不能为空

salt - 混淆盐,不能为空

返回:

加密后对密码

另请参阅:

PasswordEncoder

updatePassword

void updatePassword(String userId,
                    String oldPassword,
                    String newPassword)
             throws org.hswebframework.web.validate.ValidationException

修改用户密码

参数:

userId - 用户ID,不能为空

oldPassword - 旧的明文密码,不能为空

newPassword - 新的明文密码,不能为空

抛出:

org.hswebframework.web.validate.ValidationException - 旧密码错误时抛出此异常

另请参阅:

PasswordEncoder, UserModifiedEvent, org.springframework.context.ApplicationListener, EventListener

getUserRole

List<RoleEntity> getUserRole(String userId)

获取用户的全部角色信息

参数:

userId - 用户ID,不能为空

返回:

永远不为null, 如果用户不存在或者用户没有任何角色, 返回空集合.

selectByUserByRole

List<UserEntity> selectByUserByRole(List<String> roleIdList)

根据角色id集合获取对应的全部用户

参数:

roleIdList - 角色ID集合

返回:

用户, 不存在时返回空集合,不会返回null