Springboot 上傳文件或頭像(MultipartFile、transferTo)

1. 在配置文件中指定外部環境, 註入到代碼中

頭像上傳路徑, 若不存在, 會根據該路徑創建指定路徑文件夾

upload:
  path: D:\\upload\headImgs

創建類 FileUtils 並讀取配置文件中的值

@Component
@ConfigurationProperties(prefix = "upload")
@Data
public class FileUtils {
    private String path;
    public File getPath() {
        // 構建上傳文件的存放 "文件夾" 路徑
        String fileDirPath = new String(path);
        File fileDir = new File(fileDirPath);
        if (!fileDir.exists()) {
            // 遞歸生成文件夾
            fileDir.mkdirs();
        }
        return fileDir;
    }
    public boolean del(String filename) {
        File file = new File(path + File.separator + filename);
        return file.delete();
    }
    public boolean del(String path, String filename) {
        return new File(path + File.separator + filename).delete();
    }
}

2. 設置上傳文件的限制配置

spring:
  servlet:
    multipart:
      max-request-size: 10MB # 上傳文件的最大值
      max-file-size: 5MB # 單個文件上傳的最大值 

3. 設置外部路徑映射到url

創建config類
註意: 映射路徑時, 最後面一定要加 / (File.separator)

@Configuration
public class WebMvcConfig extends WebMvcConfigurationSupport {
    @Autowired
    private FileUtils fileUtils;
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        // 加入頭像文件夾映射 可通過 localhost:7188/headimage/....   訪問到指定位置的圖片
        registry.addResourceHandler("/static/**").addResourceLocations("classpath:/static/"); // 默認頭像
        registry.addResourceHandler("/headimage/**").addResourceLocations("file:"+fileUtils.getPath().getPath()+ File.separator);
        super.addResourceHandlers(registry);
    }
}

註意:

  • 此時映射瞭兩個路徑
  • 外部環境的路徑static目錄下的路徑(該路徑用於存放一張默認圖片隨意一張, 作為默認頭像 可命名為 default.jpg)

4. 用戶實體類中 加入 image 字段

該字段默認值為 ‘static/default.jpg’ 即為用戶的默認頭像
作用: 存放圖片的相對路徑

5. Controller層編寫

@RestController
@RequestMapping("operate/User")
public class UserController extends BaseController<UserService> {
    @ApiOperation("修改(可以修改頭像和郵箱)")
    @PutMapping
    public R modify(MultipartFile headImg, String email){
        return baseService.modify(headImg, email);
    }
}

6. Service層編寫

public interface UserService extends IService<User> {
    R modify(MultipartFile headImg, String email);
}
@Slf4j
@Service
public class UserServiceImpl extends ServiceImpl<UserDao, User> implements UserService {
    @Autowired
    private FileUtils fileUtils;
    /**
     * 獲取當前用戶名
     *
     * @return
     */
    private String getCurrentuserName() {
       // ...
        return username;
    }
    /**
     * 獲取當前用戶
     *
     * @return
     */
    public User getCurrentuser() {
       // ...
        return user;
    }
    @Override
    public R modify(MultipartFile headImg, String email) {
        // 校驗圖片格式
        if (!imageTypeRight(headImg)) return R.fail("圖片格式不正確");
        // 獲取上傳文件後的路徑
        String path = uploadFile(headImg);
        User currentuser = getCurrentuser();
        // 刪除之前的頭像(如果是默認頭像不刪除)
        String image = currentuser.getImage();
        if (!image.equals("static/default.png")) {
            if (!fileUtils.del(image.substring(path.indexOf("/") + 1))) {
                log.info("修改頭像時, 原來的頭像刪除失敗");
            } else {
                log.info("修改頭像時, 原來的頭像刪除成功");
            }
        }
        // 修改數據庫中頭像的路徑信息 和 郵箱
        update(Wrappers.<User>lambdaUpdate()
                .set(User::getEmail, email)
                .set(User::getImage, path)
                .eq(User::getUsername, currentuser.getUsername()));
        // 該路徑為圖片相對路徑 可放在url中的服務後面 進行訪問
        // 比如: http://localhost:9000/cloudos-opt/headimage/01c8806dc26d45539b53c22c766cd250.jpg
        // http://localhost:9000/cloudos-opt/static/default.png
        return R.success(null, path);
    }
    /**
     * 驗證圖片的格式
     *
     * @param file 圖片
     * @return
     */
    private boolean imageTypeRight(MultipartFile file) {
        // 首先校驗圖片格式
        List<String> imageType = Lists.newArrayList("jpg", "jpeg", "png", "bmp", "gif");
        // 獲取文件名,帶後綴
        String originalFilename = file.getOriginalFilename();
        // 獲取文件的後綴格式
        String fileSuffix = originalFilename.substring(originalFilename.lastIndexOf(".") + 1).toLowerCase();  //不帶 .
        if (!imageType.contains(fileSuffix)) return false;
        return true;
    }
     /**
     * 上傳文件
     *
     * @param file
     * @return 返回路徑
     */
    public String uploadFile(MultipartFile file) {
        String originalFilename = file.getOriginalFilename();
        String fileSuffix = originalFilename.substring(originalFilename.lastIndexOf(".") + 1).toLowerCase();
        // 隻有當滿足圖片格式時才進來,重新賦圖片名,防止出現名稱重復的情況
        String newFileName = UUID.randomUUID().toString().replaceAll("-", "") + "." + fileSuffix;
        // 該方法返回的為當前項目的工作目錄,即在哪個地方啟動的java線程
        File fileTransfer = new File(fileUtils.getPath(), newFileName);
        try {
            file.transferTo(fileTransfer);
            log.info("頭像上傳: " + fileTransfer.getPath());
        } catch (IOException e) {
            e.printStackTrace();
        }
        // 將圖片相對路徑返回給前端
        return "headimage/" + newFileName;
    }
} 

7. 測試

獲取默認頭像的路徑url為
http://localhost:8080/{spring-application-name}/static/default.jpg

修改頭像
修改完成後, 返回相對路徑

訪問修改後的頭像
帶上相對路徑在url上直接可以訪問

 到此這篇關於Springboot 上傳文件或頭像(MultipartFile、transferTo)的文章就介紹到這瞭,更多相關Springboot 上傳文件或頭像內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet!

推薦閱讀: