文档说明

此文档为拉钩Java高薪训练营2期课程学习过程，完成作业的文档。顺便说一句拉钩的课程，整个课程，体系非常全，价格上也是所有培训课程中最便宜的。如果希望构建一个整体的技术视野，非常推荐。

作业要求

使用SpringBoot和OSS实现图片的上传、下载和删除功能， 具体要求如下

  • 可以使用postman 发送上传请求 /oss/upload ，实现图片上传到OSS对应的Bucket中
    类型检查：必须为 jpg、png 或者 jpeg类型，其它图片类型返回错误提示信息
    大小检查：必须小于5M，大于5M时返回错误提示信息
    图片名称：生成的文件名，必须保持唯一
  • 可以使用postman 发送下载请求 /oss/download，实现图片下载
    可以根据图片名进行文件的下载
  • 可以使用postman 发送删除请求/oss/delete，实现图片删除
    可以根据图片名进行文件的删除

——————————————————————————————————
1、提供资料：说明文档，验证及讲解视频。
2、讲解内容包含：题目分析、实现思路、环境介绍。
—————————————————————————————————-

新建Bucke

image.png

项目搭建

aliyun.properties

  1. # aliyun.properties
  2. aliyun.endpoint=http://oss-cn-beijing.aliyuncs.com
  3. aliyun.accessKeyId=LTAI4GHJMokRfeEjNbyhdfGQ
  4. aliyun.accessKeySecret=DLjzBiTF1Eb6X7mZdOFBCzCQ6lROkI
  5. aliyun.bucketName=lg-mtest
  6. aliyun.urlPrefix=https://lg-mtest.oss-cn-beijing.aliyuncs.com/

application.properties

  1. server.port=8080
  2. # tomcat 默认上传文件大小不能超过 1M
  3. spring.servlet.multipart.max-file-size=10MB
  4. spring.servlet.multipart.max-request-size=20MB

添加依赖

  1. <dependency>
  2.   <groupId>com.aliyun.oss</groupId>
  3.   <artifactId>aliyun-sdk-oss</artifactId>
  4.   <version>2.8.3</version>
  5. </dependency>
  6. <dependency>
  7.   <groupId>org.apache.commons</groupId>
  8.   <artifactId>commons-lang3</artifactId>
  9.   <version>3.7</version>
  10. </dependency>
  11. <!-- 时间处理工具包 -->
  12. <dependency>
  13.   <groupId>joda-time</groupId>
  14.   <artifactId>joda-time</artifactId>
  15.   <version>2.9.9</version>
  16. </dependency>

AliyunConfig

  1. @Configuration
  2. // 加载配置文件
  3. @PropertySource("classpath:aliyun.properties")
  4. @ConfigurationProperties(prefix = "aliyun")
  5. public class AliyunConfig {
  7.     private String endpoint;
  8.     private String accessKeyId;
  9.     private String accessKeySecret;
  10.     private String bucketName;
  11.     private String urlPrefix;
  12.     // 生成OSSClient
  13.     @Bean
  14.     public OSSClient ossClient(){
  15.         return   new OSSClient(endpoint,accessKeyId,accessKeySecret);
  16.     }
  18.     // 省略 get set 方法
  19. }

UploadResult

  1. package com.example.demo.bean;
  3. public class UploadResult {
  5.     // 文件唯一标识
  6.     private String uid;
  7.     // 文件名
  8.     private String name;
  9.     // 状态有：uploading done error removed
  10.     private String status;
  11.     // 服务端响应内容，如：'{"status": "success"}'
  12.     private String response;
  13. }

FileService

  1. package com.example.demo.service;
  3. import com.aliyun.oss.OSSClient;
  4. import com.aliyun.oss.model.OSSObject;
  5. import com.aliyun.oss.model.ObjectMetadata;
  6. import com.example.demo.config.AliyunConfig;
  7. import org.apache.commons.lang3.StringUtils;
  8. import org.joda.time.DateTime;
  9. import org.springframework.beans.factory.annotation.Autowired;
  10. import org.springframework.stereotype.Service;
  11. import org.springframework.web.multipart.MultipartFile;
  12. import com.example.demo.bean.UploadResult;
  14. import javax.servlet.ServletOutputStream;
  15. import javax.servlet.http.HttpServletResponse;
  16. import java.io.ByteArrayInputStream;
  17. import java.io.IOException;
  18. import java.io.InputStream;
  19. import java.util.*;
  21. @Service
  22. public class FileService {
  24.     @Autowired
  25.     private AliyunConfig aliyunConfig;
  26.     @Autowired
  27.     private OSSClient ossClient;
  28.     // 允许上传的格式
  29.     private static final Set<String> IMAGE_TYPE = new HashSet<>(Arrays.asList(".jpg", ".jpeg", ".png"));
  31.     /**
  32.      * 文件上传
  33.      * @param multipartFile
  34.      * @return
  35.      */
  36.     public UploadResult upload(MultipartFile multipartFile) {
  38.         UploadResult upLoadResult = new UploadResult();
  39.         String fileName = multipartFile.getOriginalFilename();
  40.         // 校验图片格式
  41.         String fileType = fileName.substring(fileName.lastIndexOf(".")).toLowerCase();
  42.         if (!IMAGE_TYPE.contains(fileType)) {
  43.             upLoadResult.setStatus("error");
  44.             upLoadResult.setResponse("illegal media type");
  45.             return upLoadResult;
  46.         }
  47.         // 校验文件大小, 超过 5M 为非法文件
  48.         if (multipartFile.getSize()>  5 * 1024 * 1024) {
  49.             upLoadResult.setStatus("error");
  50.             upLoadResult.setResponse("file too large, file size must below 5M");
  51.             return upLoadResult;
  52.         }
  54.         String filePath = getFilePath(fileName);
  55.         try {
  56.             ObjectMetadata metadata = new ObjectMetadata();
  57.             metadata.addUserMetadata("originName", fileName);
  58.             ossClient.putObject(aliyunConfig.getBucketName(), filePath, new ByteArrayInputStream(multipartFile.getBytes()), metadata);
  59.         } catch (IOException e) {
  60.             e.printStackTrace();
  61.             // 上传失败
  62.             upLoadResult.setStatus("error");
  63.             upLoadResult.setResponse("file upload fail, some thing may be wrong");
  64.             return upLoadResult;
  65.         }
  66.         upLoadResult.setStatus("done");
  67.         upLoadResult.setName(aliyunConfig.getUrlPrefix() + filePath);
  68.         upLoadResult.setUid(filePath);
  69.         return upLoadResult;
  70.     }
  72.     /**
  73.      * 文件下载
  74.      * @param url
  75.      * @param response
  76.      */
  77.     public boolean download(String url, HttpServletResponse response) {
  78.         OSSObject object = ossClient.getObject(aliyunConfig.getBucketName(), url);
  79.         byte[] buf = new byte[1024];
  80.         int len;
  81.         try(InputStream in = object.getObjectContent(); ServletOutputStream out = response.getOutputStream()) {
  82.             while ((len = in.read(buf)) > 0) {
  83.                 out.write(buf, 0, len);
  84.             }
  85.         } catch (IOException e) {
  86.             e.printStackTrace();
  87.             return false;
  88.         }
  89.         return true;
  90.     }
  92.     /**
  93.      * 删除文件
  94.      * @param url
  95.      * @return
  96.      */
  97.     public boolean delete(String url) {
  98.         ossClient.deleteObject(aliyunConfig.getBucketName(), url);
  99.         return true;
  100.     }
  102.     // 生成不重复的文件路径和文件名
  103.     private String getFilePath(String sourceFileName) {
  104.         DateTime dateTime = new DateTime();
  105.         return "images/" + dateTime.toString("yyyy")
  106.                 + "/" + dateTime.toString("MM") + "/"
  107.                 + dateTime.toString("dd") + "/" + UUID.randomUUID().toString() + "." +
  108.                 StringUtils.substringAfterLast(sourceFileName, ".");
  109.     }
  111. }

FileController

  1. package com.example.demo.controller;
  3. import com.example.demo.bean.UploadResult;
  4. import com.example.demo.service.FileService;
  5. import org.springframework.beans.factory.annotation.Autowired;
  6. import org.springframework.stereotype.Controller;
  7. import org.springframework.web.bind.annotation.PostMapping;
  8. import org.springframework.web.bind.annotation.RequestMapping;
  9. import org.springframework.web.bind.annotation.RequestParam;
  10. import org.springframework.web.bind.annotation.ResponseBody;
  11. import org.springframework.web.multipart.MultipartFile;
  13. import javax.servlet.http.HttpServletResponse;
  15. @Controller
  16. @RequestMapping("/oss")
  17. public class FileController {
  19.     @Autowired
  20.     private FileService fileService;
  22.     @PostMapping("/upload")
  23.     @ResponseBody
  24.     public UploadResult upload(@RequestParam("file") MultipartFile multipartFile) {
  25.         return fileService.upload(multipartFile);
  26.     }
  28.     @RequestMapping("/download")
  29.     @ResponseBody
  30.     public String download(String url, HttpServletResponse response) {
  31.         boolean download = false;
  32.         try {
  33.             download = fileService.download(url, response);
  34.         } catch (Exception e) {
  35.             e.printStackTrace();
  36.         }
  37.         if (download) {
  38.             return "download success";
  39.         }
  40.         return "download failed";
  41.     }
  44.     @RequestMapping("/delete")
  45.     @ResponseBody
  46.     public String delete(String url) {
  47.         boolean download = fileService.delete(url);
  48.         if (download) {
  49.             return "delete success";
  50.         }
  51.         return "delete failed";
  52.     }
  53. }

测试

Postman 上传文件

image.png
image.png

Postman 下载文件

image.png

Postman 删除文件

image.png

异常情况测试

上传非法多媒体文件

image.png

上传大文件

image.png