2020-02-04 功能实现：根据用户角色对数据进行不可见处理

功能概述

不同用户对同一个数据列表或者单条数据存在不同的查看权限，可能A角色可以看到col1、col2，而B角色可以看到col1、col3；因此需要通过配置角色的权限，能更改用户的查看权限，当无权限查看时，该字段属性值为*

框架说明

前后端分离架构，后端使用Spring @RequestBody响应数据，定义了一个ResultBean对象进行统一响应数据

实现思路

统一拦截响应结果，对具有自定义注解的请求，根据权限对列进行不可见处理；配置用到的数据直接通过扫描注解取得

实现细节

1. Spring通过ApplicationContext扫描配置的数据，只能扫描到类级别的注解，因此需要定义一个类注解，获取需要识别的Bean

@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
public @interface ShowColsScan {
}

以上注解是为了进行配置时，能正确扫描到配置项所在的类，获取配置列表

2. 扫描到包含配置项的Bean后，需要定义注解用于实际需要进行处理不可见的请求

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface ShowCols {
    String id(); // 唯一的处理ID
    String desc(); // 方便查看用的描述
    Col[] cols(); // 供配置选择的列
}

public @interface Col {
    String name(); // 列属性链
    String desc(); // 属性名
    boolean require() default false; // 是否必须
}

以上注解是为了进行配置时，有哪些请求需要进行数据不可见处理，分别含有哪些列可供配置

3. 编码获取配置项的代码，因为每次部署项目后，配置项是固定的，如果每次都需要重新扫描一次，性能太差，所以进行缓存

public class ShowColsConfigService implements ApplicationContextAware {
    private ApplicationContext applicationContext;
    private static List<ShowColsConfigAnnotation> showColsConfigs = new ArrayList<>();

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        this.applicationContext = applicationContext;
    }

    synchronized public List<ShowColsConfigAnnotation> getShowColsConfigAnnotation(){
        if(showColsConfigs.size()>0){
            return showColsConfigs;
        }
        Map<String, Object> beansWithAnnotation = applicationContext.getBeansWithAnnotation(ShowColsScan.class);
        for (String key : beansWithAnnotation.keySet()) {
            //Spring 代理类导致Method无法获取,这里通过父类获取
            Method[] methods = beansWithAnnotation.get(key).getClass().getSuperclass().getMethods();
            for (Method method : methods) {
                System.out.println(method.getName());
                //获取指定方法上的注解的属性
                ShowCols showCols = AnnotationUtils.findAnnotation(method, ShowCols.class);
                if (null != showCols) {
                    ShowColsConfigAnnotation showColsConfig = new ShowColsConfigAnnotation(showCols.id(), showCols.desc());
                    for(Col col: showCols.cols()){
                        showColsConfig.addCols(new Column(col.name(),col.desc()));
                    }
                    showColsConfigs.add(showColsConfig);
                }
            }
        }
        return showColsConfigs;
    }

ShowColsConfigAnnotation、Column类与注解一样，只是多了构造方法；showColsConfigs存储的内容可以根据前端需要的数据获取返回需要的格式

4. 通过ResponseBodyAdvice拦截响应结果

/**
 * 结果拦截器：根据权限对结果集进行处理
 */
@RestControllerAdvice
public class MyResponseBodyAdvice implements ResponseBodyAdvice {
    @Autowired
    private ShowColsConfigService showColsConfigService;

    /**
     * 当包含注解@ShowColByPermission时才进行拦截
     */
    @Override
    public boolean supports(MethodParameter methodParameter, Class aClass) {
        return getShowColByPermissionAnnotation(methodParameter) != null;
    }

    /**
     * 处理返回结果：根据角色显示数据
     */
    @Override
    public Object beforeBodyWrite(Object o, MethodParameter methodParameter, MediaType mediaType, Class aClass, ServerHttpRequest serverHttpRequest, ServerHttpResponse serverHttpResponse) {
        if(!(o instanceof ResultBean)){
            return o;
        }

        // 1. 获得注解信息
        ShowCols annotation = getShowColByPermissionAnnotation(methodParameter);
        if(annotation == null){
            return o;
        }

        // 2. 获得需要屏蔽的列：注解中配置的列-配置的列-必须的列
        Set<String> allCols = new HashSet<>();
        Set<String> showCols = new HashSet<>();
        // 2.1 分别得到所有列allCols及必须列showCols
        for(Col col :annotation.cols()){
            allCols.add(col.name());
            if(col.require()){
                showCols.add(col.name());
            }
        }
        // 2.2 获得配置了的角色的列
        for(Role role : UserUtils.getRoleList()){
            Optional.ofNullable(showColsConfigService.get(new ShowColsConfigPo(annotation.id(),role.getId())))
                .map(ShowColsConfigPo::getShowColPaths)
                .ifPresent(obj->showCols.addAll(Arrays.asList(obj.split(","))));
        }
        // 2.3 做减法得到屏蔽的列
        allCols.removeAll(showCols);

        // 3. 根据屏蔽列处理数据
        List list = null;
        Object result = ((ResultBean) o).getResult();
        if(result instanceof Page) {
            list = ((Page) result).getList();
        }else if(result instanceof List){
            list = (List)result;
        }else{
            list = Arrays.asList(result);
        }

        if(list.size()==0) {
            return o;
        }

        for(String col : allCols){
            writeExprByDefault("#{"+col+"}",list);
        }

        return o;
    }

    private static void writeExprByDefault(String expr, List<Object> data) {
        ExpressionParser parser = new SpelExpressionParser();
        Expression expression = parser.parseExpression(expr, new TemplateParserContext());

        Object value = null;
        String typeName = expression.getValueType(data.get(0)).getName();
        if ("java.util.Date".equals(typeName)) {
           value = null;
        } else if ("java.lang.String".equals(typeName)) {
           value = "*";
        } else if ("long".equals(typeName)) {
            value = 0l;
        } else if ("int".equals(typeName)) {
            value = 0;
        }

        for(Object obj : data){
            expression.setValue(obj, value);
        }
    }

    /**
     * 获得注解@ShowCols对象
     */
    private ShowCols getShowColByPermissionAnnotation(MethodParameter methodParameter){
        if(methodParameter.getExecutable().getDeclaringClass().getAnnotation(ShowColsScan.class)==null){
            return null;
        }
        return methodParameter.getMethod().getDeclaredAnnotation(ShowCols.class);
    }
}

获取扫描到的所有配置项，与数据库中的配置进行对比做减法，剩下的列进行不可见处理

5. 附录配置表

 

使用步骤

1. 在需要控制列显示的请求所在的类上增加注解@ShowColsScan

@ShowColsScan
public class OrderProductPriceController {

2. 在需要控制列显示的请求所在的方法上增加注解@ShowCols

@ShowCols(id="42a672b243f911eaae330221860e9b7e",desc="电商报价单列表", cols={
            @Col(name="code",desc="代码"),
            @Col(name="obj.fObjName",desc="报价对象"),
            @Col(name="fcusname",desc="客户名称"),
            @Col(name="fonlinecode",desc="网店单号"),
            @Col(name="fstanderprize",desc="标准价格"),
            @Col(name="fdiscountprize",desc="折后价格"),
            @Col(name="fRemark",desc="备注"),
            @Col(name="fdate",desc="日期"),
            @Col(name="checkFlag",desc="审核",require = true)
})
public ResultBean list(OrderProductPrice baseMirrorMessage, HttpServletRequest request, HttpServletResponse response, String dsf) {

3. 在功能页面上，配置角色与列显示对应关系

备注：保存时数据前端数据被更改了，因此需要在SQL配置中增加判断是否为不可见值才来更新数据