springboot 啟動項目打印接口列表的實現(xiàn)

更新時間：2021年09月11日 08:44:50 作者：enjoy囂士

這篇文章主要介紹了springboot 啟動項目打印接口列表的實現(xiàn)方式，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教

springboot 啟動項目打印接口列表

環(huán)境

springboot 2.3.2.RELEASE

修改配置文件

logging:
  level:
    org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping: trace

結果：

在這里插入圖片描述

Springboot項目添加接口入?yún)⒔y(tǒng)一打印

需求：要求接口被調(diào)用時要打印被調(diào)用方法名，以及入?yún)⑶闆r，參數(shù)格式化時選擇fastjson

注：使用fastjson序列化時脫敏，建議入?yún)⒔y(tǒng)一使用自定義的對象類型作為入?yún)?/p>

如果不需要參數(shù)脫敏，直接使用增強中相關代碼，并去除參數(shù)脫敏相關代碼即可

新建注解，用于實現(xiàn)參數(shù)打印功能的增強

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ParamInfo {
    /**
     * 取消統(tǒng)一打印參數(shù)
     * 默認為false統(tǒng)一打印
     * 如需自定義參數(shù)打印 請賦值為true
     */
    boolean unPrint() default false;
    /**
     * 需要脫敏的字段，如密碼等
     */
    String[] fields() default {};
}

自定義序列化規(guī)則

/**
 * 序列化過濾器：值替換
 *
 */
public class ReplaceFieldFilter implements ValueFilter {
    /**
     * 需要進行替換的屬性名和替換值
     * key：屬性名
     * value：替換值
     */
    private Map<String, Object> fieldMap;
    public ReplaceFieldFilter() {
    }
    public ReplaceFieldFilter(Map<String, Object> fieldMap) {
        this.fieldMap = fieldMap;
    }
    @Override
    public Object process(Object o, String name, Object value) {
        if(!CollectionUtils.isEmpty(fieldMap)){
            Iterator<Map.Entry<String, Object>> iterator = fieldMap.entrySet().iterator();
            while (iterator.hasNext()){
                Map.Entry<String, Object> next = iterator.next();
                if(next.getKey().equalsIgnoreCase(name)){
                    return next.getValue();
                }
            }
        }
        return value;
    }
    public Map<String, Object> getFieldMap() {
        return fieldMap;
    }
    public void setFieldMap(Map<String, Object> fieldMap) {
        this.fieldMap = fieldMap;
    }
    /**
     * 傳入需要脫敏的字段名，序列化時格式化為 * 號
     */
    public ReplaceFieldFilter(String... fields) {
        String str = "******";
        fieldMap = new HashMap<>(4);
        for (String field : fields) {
            fieldMap.put(field, str);
        }
    }
}

寫參數(shù)打印增強，這里選擇環(huán)繞增強

@Component
@Aspect
//表示增強的執(zhí)行順序，如果多個增強，數(shù)值小的先被執(zhí)行
@Order(0)
public class ParamInfoAspect {
    private static final Logger LOGGER = LoggerFactory.getLogger(ParamInfoAspect.class);
    @Around("execution(* com.service.impl.*.*(..))")
    public Object printParam(ProceedingJoinPoint joinPoint) throws Throwable {
        long startTime = System.currentTimeMillis();
        String requestId = RandomStringUtils.randomAlphanumeric(16);
        Object returnValue = null;
        try {
            Object[] args = joinPoint.getArgs();
            // 獲取方法對象
            MethodSignature signature = (MethodSignature) joinPoint.getSignature();
            Method method = signature.getMethod();
            //通過注解獲取脫敏字段，之后初始化fieldMap，完成字段脫敏
            ParamInfo annotation = method.getAnnotation(ParamInfo.class);
            Map<String, Object> fieldMap = new HashMap<>(4);
            fieldMap.put("password", "******");
            if (annotation != null) {
                //獲取需要脫敏的字段名數(shù)組
                String[] fields = annotation.fields();
                for (String field : fields) {
                    fieldMap.put(field, "******");
                }
            }
            String param;
            //參數(shù)整合，多字段入?yún)⒄蠟閷ο?，單個對象入?yún)⒏袷讲蛔?
            if (args.length > 1 || (args.length == 1 && args[0].getClass() == String.class)) {
                Map<String, Object> paramMap = new LinkedHashMap<>();
                String[] parameterNames = signature.getParameterNames();
                for (int i = 0; i < parameterNames.length; i++) {
                    paramMap.put(parameterNames[i], args[i]);
                }
                param = "[" + JSON.toJSONString(paramMap, new ReplaceFieldFilter(fieldMap)) + "]";
            } else {
                param = JSON.toJSONString(args, new ReplaceFieldFilter(fieldMap));
            }
            String methodName = method.getName();
            LOGGER.info("method:[{}], parameter:{}, requestId:[{}]", methodName, param, requestId);
            returnValue = joinPoint.proceed();
            return returnValue;
        } catch (Exception e) {
            LOGGER.error("system is error:", e);
   //可在這里定義程序異常時的錯誤返回值
            returnValue = ErrorCode.SYSTEM_ERROR;
            return returnValue;
        } finally {
            LOGGER.info("request cost:{}ms, requestId:[{}]", System.currentTimeMillis() - startTime, requestId);
            LOGGER.info("returnValue:[{}], requestId:[{}]", returnValue, requestId);
        }
    }
}

以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。

您可能感興趣的文章: