快捷導(dǎo)航

SpringBoot中間件之封裝統(tǒng)一白名單配置

更新時(shí)間：2023年07月10日 14:33:07 作者：看表該更新博客了

這篇文章主要介紹了SpringBoot中間件封裝統(tǒng)一白名單配置,本文通過(guò)實(shí)例代碼給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下

背景

上線初期提供可配置的白名單用戶進(jìn)行訪問(wèn)驗(yàn)證，把控整體運(yùn)行風(fēng)險(xiǎn)。

解決痛點(diǎn)：

APOLLO企業(yè)控制也可以，多個(gè)業(yè)務(wù)功能，要配置多個(gè)apollo，如ASwitch,BSwitch，這樣會(huì)非常耗時(shí)耗力，而且等功能穩(wěn)定，要放開(kāi)企業(yè)/用戶限制時(shí)，只能將APOLLO的值置為空串或者某個(gè)特殊值（已表示對(duì)全部企業(yè)/用戶放開(kāi)），日后會(huì)殘留在代碼里。

方案設(shè)計(jì)

白名單屬于業(yè)務(wù)系統(tǒng)開(kāi)發(fā)過(guò)程中可重復(fù)使用的通用功能，所以我們把這樣的工具型功能提煉為技術(shù)組件，各個(gè)需要的使用此功能的系統(tǒng)引入此組件。

技術(shù)點(diǎn)

自定義注解、切面和springboot讀取配置文件的處理

代碼實(shí)現(xiàn)

1.切面

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface DoWhiteList {
    /**
     * key：當(dāng)前接口入?yún)⑿枰崛〉膶傩?
     * @return
     */
    String key() default "";
    /**
     * returnJson: 攔截用戶請(qǐng)求后返回的提示msg
     * @return
     */
    String returnJson() default "";
}

擴(kuò)展

@Retention(RetentionPolicy.RUNTIME)

@Target(ElementType.METHOD)

字如其名，目標(biāo)，即自定義注解DoWhiteList是要作用在類、接口還是方法上

2.配置類

/**
 * @ConfigurationProperties：用于創(chuàng)建指定前綴的自定義配置信息，這樣就在ymL或者properties中讀取到配置信息
 */
@ConfigurationProperties("com.whitelist")
public class WhiteListProperties {
    private String users;
    public String getUsers() {
        return users;
    }
    public void setUsers(String users) {
        this.users = users;
    }
}

/**
 *
 * @ConditionalOnMissingBean
 *  只會(huì)實(shí)例化一個(gè)Bean對(duì)象
 */
@Configuration
@EnableConfigurationProperties(WhiteListProperties.class)
public class WhiteListAutoConfigure {
    @Bean("whiteListConfig")
    @ConditionalOnMissingBean
    public String whiteListConfig(WhiteListProperties properties) {
        return properties.getUsers();
    }
}

3.切面

@Aspect
@Component
public class DoJoinPoint {
    private Logger logger = LoggerFactory.getLogger(DoJoinPoint.class);
    @Resource
    private String whiteListConfig;
    @Pointcut("@annotation(cn.bugstack.middleware.whitelist.annotation.DoWhiteList)")
    public void aopPoint() {
    }
    @Around("aopPoint()")
    public Object doRouter(ProceedingJoinPoint jp) throws Throwable {
        // 獲取內(nèi)容
        Method method = getMethod(jp);
        DoWhiteList whiteList = method.getAnnotation(DoWhiteList.class);
        // 獲取字段值
        String keyValue = getFiledValue(whiteList.key(), jp.getArgs());
        logger.info("middleware whitelist handler method：{} value：{}", method.getName(), keyValue);
        if (null == keyValue || "".equals(keyValue)) return jp.proceed();
        String[] split = whiteListConfig.split(",");
        // 白名單過(guò)濾
        for (String str : split) {
            if (keyValue.equals(str)) {
                return jp.proceed();
            }
        }
        // 攔截
        return returnObject(whiteList, method);
    }
    private Method getMethod(JoinPoint jp) throws NoSuchMethodException {
        Signature sig = jp.getSignature();
        MethodSignature methodSignature = (MethodSignature) sig;
        return jp.getTarget().getClass().getMethod(methodSignature.getName(), methodSignature.getParameterTypes());
    }
    // 返回對(duì)象
    private Object returnObject(DoWhiteList whiteList, Method method) throws IllegalAccessException, InstantiationException {
        Class<?> returnType = method.getReturnType();
        String returnJson = whiteList.returnJson();
        if ("".equals(returnJson)) {
            return returnType.newInstance();
        }
        return JSON.parseObject(returnJson, returnType);
    }
    // 獲取屬性值
    private String getFiledValue(String filed, Object[] args) {
        String filedValue = null;
        for (Object arg : args) {
            try {
                if (null == filedValue || "".equals(filedValue)) {
                    filedValue = BeanUtils.getProperty(arg, filed);
                } else {
                    break;
                }
            } catch (Exception e) {
                if (args.length == 1) {
                    return args[0].toString();
                }
            }
        }
        return filedValue;
    }
}