Bagaimana untuk melaksanakan pembalakan operasi secara elegan dalam projek Java SpringBoot?

1.

AOP (Pengaturcaraan Berorientasikan Aspek: Pengaturcaraan Berorientasikan Aspek), bercakap tentang AOP, hampir semua orang yang telah mempelajari rangka kerja Spring tahu bahawa ia adalah salah satu daripada tiga idea teras Spring (IOC: Inversion of Control) , DI: suntikan pergantungan, AOP: pengaturcaraan berorientasikan aspek). Ia boleh merangkumi logik atau tanggungjawab (seperti pemprosesan transaksi, pengurusan log, kawalan kebenaran, dll.) yang tidak berkaitan dengan perniagaan tetapi biasanya dipanggil oleh modul perniagaan, untuk mengurangkan pertindihan kod dalam sistem dan mengurangkan gandingan antara modul Dan ia adalah kondusif kepada kebolehskalaan dan kebolehselenggaraan masa hadapan.

2. Apa yang AOP lakukan?

Ringkasnya, AOP melakukan tiga perkara:

• 1 Di mana hendak dipotong, iaitu di mana kod bukan perniagaan seperti pembalakan terletak Kod perniagaan mana yang dilaksanakan.

• 2. Bila hendak dipotong, sebelum atau selepas kod perniagaan dilaksanakan.

• 3. Perkara yang perlu dilakukan selepas bertukar masuk, seperti pengesahan kebenaran, log masuk, dsb.

boleh difahami dengan gambar:

Istilah teras pada gambar Penerangan :

• Pointcut: Pointcut menentukan tempat untuk memotong kod perniagaan (iaitu, menenun ke dalam aspek). Pointcuts dibahagikan kepada mod pelaksanaan dan mod anotasi. Mod pelaksanaan: Anda boleh menggunakan ungkapan laluan untuk menentukan kelas yang dijalin ke dalam aspek Mod anotasi: Anda boleh menentukan kod diubah suai anotasi yang dijalin ke dalam aspek.

• Nasihat: Memproses, termasuk masa pemprosesan dan kandungan pemprosesan. Memproses kandungan bermaksud melakukan sesuatu, seperti mengesahkan kebenaran dan merekodkan log. Masa pemprosesan merujuk kepada apabila kandungan pemprosesan dilaksanakan, yang dibahagikan kepada pra-pemprosesan (iaitu, sebelum kod perniagaan dilaksanakan), pasca pemprosesan (selepas kod perniagaan dilaksanakan), dsb.

• Aspek: Aspek iaitu Pointcut dan Nasihat.

• Titik bersama: Titik bersama ialah titik pelaksanaan program. Sebagai contoh, pelaksanaan kaedah atau pengendalian pengecualian. Dalam Spring AOP, titik gabungan sentiasa mewakili pelaksanaan kaedah.

• Tenun: Tenun ke dalam ialah untuk melaksanakan proses pemprosesan kandungan dalam kaedah objek sasaran melalui proksi dinamik.

3. Langkah pelaksanaan

(1) Sesuaikan anotasi @Log (2) Buat kelas aspek, dan tetapkan titik potong untuk memintas kaedah beranotasi @Log. Pisahkan parameter yang dilalui dan rekod log (3) Tandakan @Log pada antara muka

Langkah pelaksanaan khusus adalah seperti berikut:

Tambah pergantungan AOP

Kodnya adalah seperti berikut (contoh):

 <dependency>
   	<groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
</dependency>

2. Sesuaikan anotasi log

Log biasanya menggunakan ungkapan pointcut jenis anotasi. Kami Mula-mula membuat anotasi log Apabila bekas spring mengimbas kaedah dengan anotasi ini, ia akan dipertingkatkan.

Kod adalah seperti berikut (contoh):

@Target({ ElementType.PARAMETER, ElementType.METHOD }) // 注解放置的目标位置,PARAMETER: 可用在参数上  METHOD：可用在方法级别上
@Retention(RetentionPolicy.RUNTIME)    // 指明修饰的注解的生存周期  RUNTIME：运行级别保留
@Documented
public @interface Log {

    /**
     * 模块
     */
    String title() default "";

    /**
     * 功能
     */
    public BusinessType businessType() default BusinessType.OTHER;

    /**
     * 是否保存请求的参数
     */
    public boolean isSaveRequestData() default true;

    /**
     * 是否保存响应的参数
     */
    public boolean isSaveResponseData() default true;
}

3 Pengisytiharan aspek

mengisytiharkan kelas aspek dan memberikannya kepada Spring bekas untuk pengurusan.

Kod adalah seperti berikut (contoh):

@Aspect
@Component
@Slf4j
public class LogAspect {
    @Autowired
    private IXlOperLogService operLogService;
    /**
     * 处理完请求后执行
     * @param joinPoint 切点
     */
    @AfterReturning(pointcut = "@annotation(controllerLog)", returning = "jsonResult")
    public void doAfterReturnibng(JoinPoint joinPoint, Log controllerLog, Object jsonResult) {
        handleLog(joinPoint, controllerLog, null, jsonResult);
    }
    protected void handleLog(final JoinPoint joinPoint, Log controllerLog, final Exception e, Object jsonResult) {
        try {
            // 获取当前的用户
            JwtUser loginUser = SecurityUtils.getLoginUser();

            // 日志记录
            XlOperLog operLog = new XlOperLog();
            operLog.setStatus(0);
            // 请求的IP地址
            String iP = ServletUtil.getClientIP(ServletUtils.getRequest());
            if ("0:0:0:0:0:0:0:1".equals(iP)) {
                iP = "127.0.0.1";
            }
            operLog.setOperIp(iP);
            operLog.setOperUrl(ServletUtils.getRequest().getRequestURI());
            if (loginUser != null) {
                operLog.setOperName(loginUser.getUsername());
            }
            if (e != null) {
                operLog.setStatus(1);
                operLog.setErrorMsg(StringUtils.substring(e.getMessage(), 0, 2000));
            }
            // 设置方法名称
            String className = joinPoint.getTarget().getClass().getName();
            String methodName = joinPoint.getSignature().getName();
            operLog.setMethod(className + "." + methodName + "()");
            operLog.setRequestMethod(ServletUtils.getRequest().getMethod());
            operLog.setOperTime(new Date());
            // 处理设置注解上的参数
            getControllerMethodDescription(joinPoint, controllerLog, operLog, jsonResult);
            // 保存数据库
            operLogService.save(operLog);

        } catch (Exception exp) {
            log.error("异常信息:{}", exp.getMessage());
            exp.printStackTrace();
        }
    }
    /**
     * 获取注解中对方法的描述信息 用于Controller层注解
     * @param log 日志
     * @param operLog 操作日志
     * @throws Exception
     */
    public void getControllerMethodDescription(JoinPoint joinPoint, Log log, XlOperLog operLog, Object jsonResult) throws Exception {
        // 设置操作业务类型
        operLog.setBusinessType(log.businessType().ordinal());
        // 设置标题
        operLog.setTitle(log.title());
        // 是否需要保存request，参数和值
        if (log.isSaveRequestData()) {
            // 设置参数的信息
            setRequestValue(joinPoint, operLog);
        }
        // 是否需要保存response，参数和值
        if (log.isSaveResponseData() && StringUtils.isNotNull(jsonResult)) {
            operLog.setJsonResult(StringUtils.substring(JSON.toJSONString(jsonResult), 0, 2000));
        }
    }
    /**
     * 获取请求的参数，放到log中
     * @param operLog 操作日志
     * @throws Exception 异常
     */
    private void setRequestValue(JoinPoint joinPoint, XlOperLog operLog) throws Exception {
        String requsetMethod = operLog.getRequestMethod();
        if (HttpMethod.PUT.name().equals(requsetMethod) || HttpMethod.POST.name().equals(requsetMethod)) {
            String parsams = argsArrayToString(joinPoint.getArgs());
            operLog.setOperParam(StringUtils.substring(parsams,0,2000));
        } else {
            Map<?,?> paramsMap = (Map<?,?>) ServletUtils.getRequest().getAttribute(HandlerMapping.URI_TEMPLATE_VARIABLES_ATTRIBUTE);
            operLog.setOperParam(StringUtils.substring(paramsMap.toString(),0,2000));
        }
    }
    /**
     * 参数拼装
     */
    private String argsArrayToString(Object[] paramsArray) {
        String params = "";
        if (paramsArray != null && paramsArray.length > 0) {
            for (Object object : paramsArray) {
                // 不为空 并且是不需要过滤的 对象
                if (StringUtils.isNotNull(object) && !isFilterObject(object)) {
                    Object jsonObj = JSON.toJSON(object);
                    params += jsonObj.toString() + " ";
                }
            }
        }
        return params.trim();
    }
    /**
     * 判断是否需要过滤的对象。
     * @param object 对象信息。
     * @return 如果是需要过滤的对象，则返回true；否则返回false。
     */
    @SuppressWarnings("rawtypes")
    public boolean isFilterObject(final Object object) {
        Class<?> clazz = object.getClass();
        if (clazz.isArray()) {
            return clazz.getComponentType().isAssignableFrom(MultipartFile.class);
        } else if (Collection.class.isAssignableFrom(clazz)) {
            Collection collection = (Collection) object;
            for (Object value : collection) {
                return value instanceof MultipartFile;
            }
        } else if (Map.class.isAssignableFrom(clazz)) {
            Map map = (Map) object;
            for (Object value : map.entrySet()) {
                Map.Entry entry = (Map.Entry) value;
                return entry.getValue() instanceof MultipartFile;
            }
        }
        return object instanceof MultipartFile || object instanceof HttpServletRequest
                || object instanceof HttpServletResponse || object instanceof BindingResult;
    }
}

4 Tandakan pada antara muka

Tandai anotasi tersuai rekod yang diperlukan Pada antara muka log operasi, kod adalah seperti berikut (contoh):

	@Log(title = "代码生成", businessType = BusinessType.GENCODE)
    @ApiOperation(value = "批量生成代码")
    @GetMapping("/download/batch")
    public void batchGenCode(HttpServletResponse response, String tables) throws IOException {
        String[] tableNames = Convert.toStrArray(tables);
        byte[] data = genTableService.downloadCode(tableNames);
        genCode(response, data);
    }

5 Kesan dicapai

Apabila operasi yang berkaitan dilakukan, log akan direkodkan, dan beberapa maklumat dan data asas akan direkodkan di dalam dan di luar.

Atas ialah kandungan terperinci Bagaimana untuk melaksanakan pembalakan operasi secara elegan dalam projek Java SpringBoot?. Untuk maklumat lanjut, sila ikut artikel berkaitan lain di laman web China PHP!