快速上手-权限校验

本节中将会介绍如何通过注解进行权限校验。首个案例为验证请求参数中是否携带key为114514的参数。

第一步：添加maven依赖

<dependency>
    <groupId>io.github.liuye744</groupId>
    <artifactId>simpleAuth-spring-boot-starter</artifactId>
    <version>1.4.7.RELEASE</version>
</dependency>

第二部：创建Handler

创建一个类继承AutoAuthHandler，并重写isAuthor函数

public class KeyAutoAuthHandler extends AutoAuthHandler {
   @Override
   public boolean isAuthor(HttpServletRequest request, String permission) {
        //验证请求参数中是否携带key为114514的参数. 
        //当然也可以进行更复杂的操作
       final String key = request.getParameter("key");
       //返回true则表示验证成功，返回false表示验证失败将会抛出PermissionsException
       return "114514".equals(key);
   }
}

第三步：添加注解

然后将@SimpleAuth注释添加到 Controller 或其中的函数。
若添加到类上，则执行类中所有方法前均执行该Handler

@Controller
@SimpleAuth(handler = KeyAutoAuthHandler.class)
public class MyController {
}

若添加到方法上，则执行该方法前执行该Handler

@RestController
public class MyController {

    @SimpleAuth(handler = AddPermissionKeyHandler.class)
    @GetMapping("say")
    public String say(){
        return "Hello World";
    }
}

注: 如果你有多个AutoAuthHandler，你可以像这样写注释:

@SimpleAuth (handler = { KeyAutoAuthHandler1.class，KeyAutoAuthHandler2.class })

handler参数也可以写 Handler 的Bean 名称。这些类将按顺序执行权限检查。或者创建 继承AutoAuthHandlerChain 的类，并将所有 Handler 添加到该类中。

public class MyHandlerChain extends AutoAuthHandlerChain {
   @Override
   public void addChain() {
       this.addLast(KeyAutoAuthHandler1.class)
        .addLast(KeyAutoAuthHandler2.class);
   }
}
//添加注解时使用 @SimpleAuth(handlerChain = MyHandlerChain.class)

其他案例

用例1：基于角色的权限校验

@RestController
//添加注解到类
@SimpleAuth(authentication = AddPermissionKeyHandler.class)
public class MyController {
   @SimpleAuth("visitor")
   @GetMapping("say")
   public String say(){
       return "Hello World";
   }

   @SimpleAuth("vip")
   @GetMapping("eat")
   public String eat(){
       return "eat";
   }
}
public class AddPermissionKeyHandler extends AutoAuthHandler {
   @Override
   public boolean isAuthor(HttpServletRequest request, String permission) {
       ArrayList<String> permissions = new ArrayList<>();
       //或者查询数据库为当前请求添加角色key
       permissions.add("visitor");
       this.setPermissions(request,permissions);
       //查询成功，放行
       return true;
   }
}

当请求/say时，由于注释@SimpleAuth 被添加到 MyController类上，AddPermisonKeyHandler 中的 SimpleAuth 函数将首先运行。在这个函数中，字符串visitor被添加到用户的权限中，因此它将会验证通过并正常访问。
当请求/eat时，由于权限列表中没有“vip”则会请求失败，抛出PermissionsException异常，可以通过全局异常处理完成权限校验

用例2：传递实例对象

//用到的实例
public class User {
    String name;
    public User(String name) {this.name = name;}
    public String getName() {return name;}
}
//接口
@RestController
public class MyController {
    @SimpleAuth(handler = {MyFirstHandler.class, MySecondHandler.class})
    @GetMapping("/say")
    public String say(){
        return "Hello World";
    }
}

//第一个Handler
public class MyFirstHandler extends AutoAuthHandler {
    @Override
    public boolean isAuthor(HttpServletRequest request, String permission) {
        final String name = request.getParameter("name");
        final User user = new User(name);
        //传递实例对象
        setPrincipal(user);
        //放行
        return true;
    }
}
//第二个Handler
public class MySecondHandler extends AutoAuthHandler {
    @Override
    public boolean is(HttpServletRequest request, String permission) {
        //获取实例对象,并验证name是否等于CodingCube
        final User user = getPrincipal();
        return "CodingCube".equals(user.getName());
    }
}

当访问 http://localhost:8080/say?name=CodingCube 时可以通过，参数name为其他时抛出PermissionsException异常