文件解析 | SpringBoot 自定义注解实现文件自动保存

1.前言

在项目里面通常有文件需要处理，但是基本上都差不多，本想抽象成通用的方法，后面改成了注解实现。

主要原理在接口方法上添加注解 --- 拦截注解获取文件流 --- 保存文件生成url --- 把结果塞到对应的bean属性里面

2.代码

文件自动注入注解

import com.gl.common.core.constant.GlEnum;

import java.lang.annotation.*;

/**
 * 文件自动注入
 * <p>作用于方法上，自动处理 MultipartFile 文件并返回 url 注入实体类</p>
 * <P>多个以 , 分开</P>
 * <p>注意，方法必须含有 HttpServletRequest 参数</p>
 *
 * @author wbw
 * @date 2020/11/11 23:26
 */
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface FileBashfulInfuse {
    /**
     * 文件类型
     */
    GlEnum value();

    /**
     * 忽略的 文件名
     */
    String[] ignore() default {};

    /**
     * 文件后缀
     * <p>默认是 实体类 属性 + File</p>
     * <p>前端传过来的，会去掉该后缀注入对象属性</p>
     */
    String suffix() default "";

    /**
     * 设置文件值为 id
     */
    boolean reId() default false;
}

文件自动注入拦截器

import cn.hutool.core.bean.BeanUtil;
import cn.hutool.core.util.StrUtil;
import cn.hutool.json.JSONObject;
import com.gl.core.annotation.FileBashfulInfuse;
import com.gl.train.domain.FileAnnex;
import com.gl.train.service.IFileAnnexService;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;
import org.springframework.web.multipart.MultipartFile;
import org.springframework.web.multipart.MultipartHttpServletRequest;
import org.springframework.web.util.WebUtils;

import javax.servlet.http.HttpServletRequest;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.stream.Collectors;

/**
 * 文件自动注入
 *
 * @author wbw
 * @date 2020/11/11 23:35
 */
@Component
@Aspect
public class FileBashfulInfuseResolver {

    @Autowired
    private IFileAnnexService fileAnnexService;

    /**
     * 根据注解拦截请求入参信息
     * 获取文件解析对应url 注入 入参参数
     */
    @Around("@annotation(infuse)")
    public Object fileInject(ProceedingJoinPoint pjp, FileBashfulInfuse infuse) throws Throwable {
        // 获取执行参数
        Object[] objects = pjp.getArgs();
        if (infuse == null) {
            return pjp.proceed(objects);
        }
        // 获取 HttpServletRequest
        HttpServletRequest request = null;
        for (Object obj : objects) {
            if (obj instanceof HttpServletRequest) {
                request = (HttpServletRequest) obj;
                break;
            }
        }
        if (request == null) {
            return pjp.proceed(objects);
        }
        // 获取文件流信息
        MultipartHttpServletRequest mhp = WebUtils.getNativeRequest(request, MultipartHttpServletRequest.class);
        if (mhp == null) {
            return pjp.proceed(objects);
        }
        JSONObject obj = new JSONObject();
        // 处理文件的
        for (Map.Entry<String, List<MultipartFile>> entry : mhp.getMultiFileMap().entrySet()) {
            String fileName = entry.getKey();
            // 忽略的文件
            Set<String> ignores = Arrays.stream(infuse.ignore()).collect(Collectors.toSet());
            if (ignores.contains(fileName)) {
                continue;
            }
            // 生成文件
            String urls = entry.getValue().stream()
                    .map(multipartFile -> {
                        FileAnnex fileAnnex = fileAnnexService.uploadAndGet(multipartFile, infuse.value(), null);
                        return infuse.reId() ? String.valueOf(fileAnnex.getId()) : fileAnnex.getUrl();
                    })
                    .collect(Collectors.joining(","));
            // 设置处理值
            obj.set(StrUtil.removeSuffix(fileName, infuse.suffix()), urls);
        }
        // 赋值
        for (Object o : objects) {
            BeanUtil.copyProperties(obj, o);
        }
        // 处理原始 requestBody || 单个参数
        return pjp.proceed(objects);
    }
}

3.使用

注意这里必须要存在 HttpServletRequest