代码拉取完成，页面将自动刷新
该项目帮助开发者快速，简单的，使用0配置，就可以集成shiro框架。
demo传送门：https://github.com/justsosoG/idong/tree/master
https://apidoc.gitee.com/justsosoG/easy-shiro/
这里以当下流行的spring boot作为例子，以下示例代码以1.0.0版本为例
<dependency>
<groupId>org.njgzr</groupId>
<artifactId>easy-shiro</artifactId>
<version>${latest.version}</version>
</dependency>
新建配置类并添加注解，如：
@EnableEasyShiro
@Configuration
public class LoginConfig {
}
如使用的是springboot，只需在启动类上加上该注解：
@SpringBootApplication
@EnableEasyShiro
public class Demo2Application {
public static void main(String[] args) {
SpringApplication.run(Demo2Application.class, args);
}
}
实现4个接口
ConfigGetService（注入配置）
LoginResultService（登陆结果的回调，用作记登陆日志等）
SecurityService（校验账号密码正确性）
AuthorizedUser（登录成功后可以使用AuthorizedUser user = SecurityUtil.getCurrentUser();获得当前登录的用户信息。）
注意：1、存在数据库的密码加密方式必须为：new Password(要加密的字符串).toString()
这里采用的盐的加密方式，相同的密码加密的结果都不一样，所以安全性大家放心。
例子：
@Service
public class ServiceImpl implements ConfigGetService,LoginResultService,SecurityService{
/**
* principal是登录名
*/
@Override
public AuthorizedUser findByPrincipal(Object principal) {
// 开发时，这里应该从数据库读取，参数principal为登录名
if (principal instanceof String) {
User user = userService.findByLoginName((String) principal);// 本地账号
if (user == null)
return null;
AuthorizedUserInfo info = new AuthorizedUserInfo();//这里的AuthorizedUserInfo实现了AuthorizedUser接口
Long orgid = user.getOrganizationId();
info.setUploadUrl(user.getUploadUrl());
info.setDisplayName(user.getDisplayName());
info.setId(user.getId());
info.setLoginName(user.getLoginName());
info.setMobile(user.getMobile());
info.setType(user.getType());
info.setOrganizationId(orgid);
info.setDefaultCauseId(user.getDefaultCauseId());
info.setAddress(user.getAddress());
info.setPermissions(permissions);
info.setRoles(roles);
log.info(info.toString());
return info;
// 这里的info会返回给前端，
// 后端也可以使用AuthorizedUserInfo info = (AuthorizedUserInfo) SecurityUtil.getCurrentUser();来获取
}
return null;
}
@Override
public Password findPassword(AuthorizedUser user) {
// 开发时，这里应该从数据库读取，使用user中的id获取数据库中该用户记录，并返回密码字段，注意这里应返回Password类型
User user = userService.findById(authorizedUser.getId());
return user == null ? null : user.getPassword();
}
/**
* 登录成功后的回调
*/
@Override
public void loginSuccess(Long userId, String loginName, String terminal, String addr, String ip,String os,String browser) {
System.err.println(loginName+"登陆成功");
}
/**
* 设置同一个账号同时登陆的个数
*/
@Override
public Long maxSessionCount() {
return 2L;
}
/**
* 免认证的接口
*/
@Override
public List<String> anons() {
List<String> dList = Lists.newArrayList();
return dList;
}
/**
* 返回null则基于内存模式
*/
@Override
public StringRedisTemplate getStringRedisTemplate() {
return stringRedisTemplate;
}
@Autowired
private StringRedisTemplate stringRedisTemplate;
/**
* 系统标识符
*/
@Override
public String getAppId() {
return "Idong";
}
/**
* web应用的令牌有效时间，返回null则默认为30分钟
*/
@Override
public Long webExpireTime() {
return 30 * 60 * 1000L;
}
/**
* 手机应用的令牌有效时间，返回null则默认为1个月
*/
@Override
public Long appExpireTime() {
return 30 * 60 * 1000L;
}
/**
* pc应用的令牌有效时间，返回null则默认为1天
*/
@Override
public Long pcExpireTime() {
return 30 * 60 * 1000L;
}
/**
* 登录请求中用户名的字段，返回null则默认为username
*/
@Override
public String loginUserNameParam() {
return null;
}
/**
* 登录请求中密码的字段，返回null则默认为password
*/
@Override
public String loginPasswordParam() {
return null;
}
/**
* 请求头中的令牌字段，返回null则默认为 token
*/
@Override
public String headerToken() {
return "myToken";
}
/**
* 登录接口的地址，返回null则默认是 /login
*/
@Override
public String loginUrl() {
return null;
}
/**
* 登出回调
*/
@Override
public void logout(Long userId, String loginName) {
// TODO Auto-generated method stub
}
/**
* 登录失败的回调
*/
@Override
public void loginFail(String loginName, Exception e) {
// TODO Auto-generated method stub
}
/**
* 登录请求中验证码的字段，返回null则默认为captchaCode
*/
@Override
public String captchaParam() {
return null;
}
/**
* 最大的错误次数，如果超过该数字或者返回0，系统将校验验证码
*/
@Override
public int maxClfCount() {
return 2;
}
/**
* 验证码的长度，最长6位，最短4位，如为算术验证码，则默认是两个数字的算术题
*/
@Override
public int captchaLenth() {
return 4;
}
/**
* 验证码图片的大小，格式为 宽,高 ，逗号为英文状态的逗号，返回null则默认 110,40
*/
@Override
public String captchaSize() {
return "120,60";
}
/**
* 是否开启验证码
*/
@Override
public boolean enableCaptcha() {
return true;
}
/**
* 验证码类型，目前可选的为 specCaptcha,gifCaptcha,chineseCaptcha,chineseGifCaptcha,arithmeticCaptcha，
* 如果返回null，则默认随机，中文验证码存在问题，暂时不推荐使用
* 可选值参考org.njgzr.security.enums.CaptchaType
* 若返回随意字符串，则默认specCaptcha
*/
@Override
public String captchaType() {
return null;
}
}
@Setter @ToString @Getter
public class AuthorizedUserInfo implements AuthorizedUser {
// 登录成功后你可以使用AuthorizedUserInfo o = (AuthorizedUserInfo) SecurityUtil.getCurrentUser();
// 来获取当前登录的用户信息，所以这里你可以任意加你需要的字段在里面，比如我这里的ip等等；
// 同时登陆成功后，这些字段会同样返回给前端。
private Long id;
private String loginName;
private String displayName;
private Date expireTime;
private String mobile;
private String ip;
private boolean isLocked;
private boolean isDisable;
private Long organizationId;
private String roles;
private Set<String> permissions;
private Set<String> roles;
@Override
public Set<String> getStringRoles() {
return roles;
}
@Override
public Set<String> getStringPermissions() {
return permissions;
}
}
到这里，你就可以调用/login接口进行登陆操作，
参数为username和password两个，header中可以添加teminal，来标识你是浏览器、app应用、pc端应用，该字段影响下发token的有效时间
提交方式为post，contentType为application/json或application/x-www-form-urlencoded两种方式。
请求成功后会在boday中返回登陆信息（AuthorizedUserInfo这个类），并在response headers中返回token值，同时会把token写入cookie中。
调用你的其他接口怎么办？
每次请求时，将登陆返回的token值放在header中即可
token过期了怎么办？
token过期后一分钟内，会得到1分钟的豁免时间，也就是在过期后一分钟内，该token还是可以用的，用来保证，还没有完成的请求能够正常返回，
同时，在这一分钟内的请求返回中，会在response headers中返回新的token，并把token写入cookie中。实际开发过程中，只要发现response headers中有返回token值，就将以前的token覆盖即可。
你也可以写一个定时器，定时访问某个接口，用来保证你的token是最新的。
验证码的地址是多少：http://ip:port/captcha
何时需要验证码呢？
{
"code": 501,
"data": {
"captchaEnabled": true
},
"desc": "验证码错误",
"success": false,
"time": 1576639456428
}
当出现这个返回值，则需要验证码。
接口怎么限流呢？
在需要被限流的接口上加上注解@LxRateLimit(perSecond = 10.0)
perSecond表示该接口每秒被调用的次数
注意：
接口返回统一类型：Result
@LxRateLimit(perSecond = 10.0)
@RequestMapping(value="/getStr",method={RequestMethod.POST})
public Result getString() {
return Result.success("hello-"+new SimpleDateFormat("yyyyMMddHHmmss").format(new Date()));
}
如何进行接口的角色或权限校验？
首先在实现的AuthorizedUser中定义Set permissions和Set roles，
并在实现的SecurityService接口findByPrincipal中，对这两个字段进行赋值，最后在需要鉴权的接口上加上如下注解：
@LxRateLimit(perSecond = 10.0)
@RequestMapping(value="/getStr",method={RequestMethod.POST})
@RequiresRoles(value = { "role1","role2" })
@RequiresPermissions(value = { "per1","per2" })
public Result getString() {
return Result.success("hello-"+new SimpleDateFormat("yyyyMMddHHmmss").format(new Date()));
}
此处可能存在不合适展示的内容，页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容，可点击提交进行申诉，我们将尽快为您处理。
1. 开源生态
2. 协作、人、软件
3. 评估模型