SpringBoot整合阿里云OSS文件上傳勃黍、下載、查看晕讲、刪除

該項目源碼地址:https://github.com/ggb2312/JavaNotes/tree/master/springboot-integration-examples (其中包含SpringBoot和其他常用技術的整合覆获,配套源碼以及筆記∑笆。基于最新的 SpringBoot2.1+弄息,歡迎各位 Star)

1. 開發(fā)前準備

1.1 前置知識

  • java基礎
  • SpringBoot簡單基礎知識

1.2 環(huán)境參數(shù)

  • 開發(fā)工具:IDEA
  • 基礎環(huán)境:Maven+JDK8
  • 所用技術:SpringBoot、lombok勤婚、阿里云OSS存儲服務
  • SpringBoot版本:2.1.4

1.3 涉及知識點

  • OSS簡介摹量,以及阿里云OSS控制臺快速入門使用
  • SpringBoot 整合 阿里云OSS 存儲服務,進行文件上傳、下載缨称、查看凝果、刪除
  • 阿里云OSS文檔介紹,以及快速入門使用
  • lombok入門使用以及IDEA lombok插件安裝
  • SpringMVC與AJAX前后端分離交互
  • AJAX文件異步上傳

2. 使用阿里云OSS

對象存儲OSS的多重冗余架構設計睦尽,為數(shù)據(jù)持久存儲提供可靠保障器净。

2.1 創(chuàng)建Bucket

使用OSS,首先需要創(chuàng)建Bucket当凡,Bucket翻譯成中文是水桶的意思山害,把存儲的圖片資源看做是水,想要盛水必須得
有桶沿量。
進入控制臺浪慌,https://oss.console.aliyun.com/overview

新建Bucket
新建 Bucket

創(chuàng)建完成后,在左側可以看到已經(jīng)創(chuàng)建好的Bucket:

Bucket

選擇Bucket后朴则,即可看到對應的信息权纤,如:url、消耗流量等

Bucket相關信息

2.2 管理文件

可以通過在線的方式進行管理文件

管理文件

2.3 阿里云OSS文檔

阿里云OSS文檔

阿里云OSS文檔

右側的開發(fā)指南說的更加詳細


開發(fā)指南

阿里云雖然提供了完整的文檔乌妒,但是做一個完整的前后端交互的文件上傳妖碉、下載、查看芥被、刪除等操作欧宜,對于小白來說還是有點難度的,所以我把自己學習OSS的步驟以及代碼分享了出來拴魄,共有需要的人使用冗茸。

3. 項目初始化

3.1 創(chuàng)建SpringBoot項目

在Idea中File——>New——>Project


創(chuàng)建SpringBoot項目 步驟一
創(chuàng)建SpringBoot項目 步驟二
創(chuàng)建SpringBoot項目 步驟三
創(chuàng)建SpringBoot項目 步驟四

3.2 Maven依賴

導入Maven相關依賴

<dependency>
            <groupId>com.aliyun.oss</groupId>
            <artifactId>aliyun-sdk-oss</artifactId>
            <version>2.8.3</version>
        </dependency>

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.4</version>
            <scope>provided</scope>
        </dependency>

        <dependency>
            <groupId>joda-time</groupId>
            <artifactId>joda-time</artifactId>
            <version>2.9.9</version>
        </dependency>

        <dependency>
            <groupId>org.apache.commons</groupId>
            <artifactId>commons-lang3</artifactId>
            <version>3.8.1</version>
        </dependency>

3.3 安裝lombok插件

因為項目中使用了lombok的@Data注解,當然你也可以自己寫get匹中、set等方法夏漱。
File——>settings——>Plugins

安裝lombok插件

安裝lombok插件

然后restart IDEA即可。

4. 后端服務編寫

項目結構

4.1 阿里云OSS配置

在resource下新建一個application-oss.properties

aliyun.endpoint=oss-cn-shanghai.aliyuncs.com
aliyun.accessKeyId=你的accessKeyId
aliyun.accessKeySecret=你的accessKeySecret
aliyun.bucketName=gaojun-testbucket
aliyun.urlPrefix=http://gaojun-testbucket.oss-cn-shanghai.aliyuncs.com/
spring.servlet.multipart.max-file-size=100MB
spring.servlet.multipart.max-request-size=1000MB

endpoint顶捷、bucketName挂绰、urlPrefix在OSS主面板就可以看到

bucketName、endpoint與urlPrefix

accessKeyId服赎、accessKeySecret需要在accesskeys里面查看

accesskeys與accessKeySecret

在java的包下新建一個config包葵蒂,創(chuàng)建一個AliyunConfig.java

package com.example.ossdemo.config;

import com.aliyun.oss.OSS;
import com.aliyun.oss.OSSClient;
import lombok.Data;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.PropertySource;
/**
 * @desc
 *
 * @author lastwhisper
 * @email gaojun56@163.com
 */
@Configuration
@PropertySource(value = {"classpath:application-oss.properties"})
@ConfigurationProperties(prefix = "aliyun")
@Data
public class AliyunConfig {
    private String endpoint;
    private String accessKeyId;
    private String accessKeySecret;
    private String bucketName;
    private String urlPrefix;

    @Bean
    public OSS oSSClient() {
        return new OSSClient(endpoint, accessKeyId, accessKeySecret);
    }
}

4.2 后端業(yè)務

4.2.1 vo

該實體類用于后臺返回給前臺。

package com.example.ossdemo.vo;

import lombok.Data;

/**
 * @author lastwhisper
 * @desc 用于前后端交互的返回值
 * @email gaojun56@163.com
 */
@Data
public class FileUploadResult {
    // 文件唯一標識
    private String uid;
    // 文件名
    private String name;
    // 狀態(tài)有:uploading done error removed
    private String status;
    // 服務端響應內(nèi)容重虑,如:'{"status": "success"}'
    private String response;
}

4.2.2 service

在service使用ossClient操作阿里云OSS践付,進行上傳、下載缺厉、刪除永高、查看所有文件等操作隧土,同時可以將圖片的url進行入庫操作。

package com.example.ossdemo.service;

import com.aliyun.oss.OSS;
import com.aliyun.oss.model.*;
import com.example.ossdemo.config.AliyunConfig;
import com.example.ossdemo.vo.FileUploadResult;
import org.apache.commons.lang3.RandomUtils;
import org.apache.commons.lang3.StringUtils;
import org.joda.time.DateTime;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import org.springframework.web.multipart.MultipartFile;

import java.io.*;
import java.util.List;

/**
 * @author lastwhisper
 * @desc
 * @email gaojun56@163.com
 */
@Service
public class FileUploadService {
    // 允許上傳的格式
    private static final String[] IMAGE_TYPE = new String[]{".bmp", ".jpg",
            ".jpeg", ".gif", ".png"};
    @Autowired
    private OSS ossClient;
    @Autowired
    private AliyunConfig aliyunConfig;

    /**
     * @author lastwhisper
     * @desc 文件上傳
     * 文檔鏈接 https://help.aliyun.com/document_detail/84781.html?spm=a2c4g.11186623.6.749.11987a7dRYVSzn
     * @email gaojun56@163.com
     */
    public FileUploadResult upload(MultipartFile uploadFile) {
        // 校驗圖片格式
        boolean isLegal = false;
        for (String type : IMAGE_TYPE) {
            if (StringUtils.endsWithIgnoreCase(uploadFile.getOriginalFilename(),
                    type)) {
                isLegal = true;
                break;
            }
        }
        //封裝Result對象命爬,并且將文件的byte數(shù)組放置到result對象中
        FileUploadResult fileUploadResult = new FileUploadResult();
        if (!isLegal) {
            fileUploadResult.setStatus("error");
            return fileUploadResult;
        }
        //文件新路徑
        String fileName = uploadFile.getOriginalFilename();
        String filePath = getFilePath(fileName);
        // 上傳到阿里云
        try {
            ossClient.putObject(aliyunConfig.getBucketName(), filePath, new
                    ByteArrayInputStream(uploadFile.getBytes()));
        } catch (Exception e) {
            e.printStackTrace();
            //上傳失敗
            fileUploadResult.setStatus("error");
            return fileUploadResult;
        }
        fileUploadResult.setStatus("done");
        fileUploadResult.setResponse("success");
        //this.aliyunConfig.getUrlPrefix() + filePath 文件路徑需要保存到數(shù)據(jù)庫
        fileUploadResult.setName(this.aliyunConfig.getUrlPrefix() + filePath);
        fileUploadResult.setUid(String.valueOf(System.currentTimeMillis()));
        return fileUploadResult;
    }

    /**
     * @author lastwhisper
     * @desc 生成路徑以及文件名 例如://images/2019/04/28/15564277465972939.jpg
     * @email gaojun56@163.com
     */
    private String getFilePath(String sourceFileName) {
        DateTime dateTime = new DateTime();
        return "images/" + dateTime.toString("yyyy")
                + "/" + dateTime.toString("MM") + "/"
                + dateTime.toString("dd") + "/" + System.currentTimeMillis() +
                RandomUtils.nextInt(100, 9999) + "." +
                StringUtils.substringAfterLast(sourceFileName, ".");
    }

    /**
     * @author lastwhisper
     * @desc 查看文件列表
     * 文檔鏈接 https://help.aliyun.com/document_detail/84841.html?spm=a2c4g.11186623.2.13.3ad5b5ddqxWWRu#concept-84841-zh
     * @email gaojun56@163.com
     */
    public List<OSSObjectSummary> list() {
        // 設置最大個數(shù)曹傀。
        final int maxKeys = 200;
        // 列舉文件。
        ObjectListing objectListing = ossClient.listObjects(new ListObjectsRequest(aliyunConfig.getBucketName()).withMaxKeys(maxKeys));
        List<OSSObjectSummary> sums = objectListing.getObjectSummaries();
        return sums;
    }

    /**
     * @author lastwhisper
     * @desc 刪除文件
     * 文檔鏈接 https://help.aliyun.com/document_detail/84842.html?spm=a2c4g.11186623.6.770.4f9474b4UYlCtr
     * @email gaojun56@163.com
     */
    public FileUploadResult delete(String objectName) {
        // 根據(jù)BucketName,objectName刪除文件
        ossClient.deleteObject(aliyunConfig.getBucketName(), objectName);
        FileUploadResult fileUploadResult = new FileUploadResult();
        fileUploadResult.setName(objectName);
        fileUploadResult.setStatus("removed");
        fileUploadResult.setResponse("success");
        return fileUploadResult;
    }

    /**
     * @author lastwhisper
     * @desc 下載文件
     * 文檔鏈接 https://help.aliyun.com/document_detail/84823.html?spm=a2c4g.11186623.2.7.37836e84ZIuZaC#concept-84823-zh
     * @email gaojun56@163.com
     */
    public void exportOssFile(OutputStream os, String objectName) throws IOException {
        // ossObject包含文件所在的存儲空間名稱饲宛、文件名稱卖毁、文件元信息以及一個輸入流。
        OSSObject ossObject = ossClient.getObject(aliyunConfig.getBucketName(), objectName);
        // 讀取文件內(nèi)容落萎。
        BufferedInputStream in = new BufferedInputStream(ossObject.getObjectContent());
        BufferedOutputStream out = new BufferedOutputStream(os);
        byte[] buffer = new byte[1024];
        int lenght = 0;
        while ((lenght = in.read(buffer)) != -1) {
            out.write(buffer, 0, lenght);
        }
        if (out != null) {
            out.flush();
            out.close();
        }
        if (in != null) {
            in.close();
        }
    }
}

4.2.3 controller

controller進行接收用戶請求

package com.example.ossdemo.controller;

import com.aliyun.oss.model.OSSObjectSummary;
import com.example.ossdemo.service.FileUploadService;
import com.example.ossdemo.vo.FileUploadResult;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.multipart.MultipartFile;

import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.io.InputStream;
import java.net.URLEncoder;
import java.util.List;

/**
 * @author lastwhisper
 * @desc
 * @email gaojun56@163.com
 */
@Controller
public class FileUploadController {
    @Autowired
    private FileUploadService fileUploadService;

    /**
     * @author lastwhisper
     * @desc 文件上傳到oss
     * @return FileUploadResult
     * @Param uploadFile
     */
    @RequestMapping("file/upload")
    @ResponseBody
    public FileUploadResult upload(@RequestParam("file") MultipartFile uploadFile)
            throws Exception {
        return this.fileUploadService.upload(uploadFile);
    }

    /**
     * @return FileUploadResult
     * @desc 根據(jù)文件名刪除oss上的文件
     * http://localhost:8080/file/delete?fileName=images/2019/04/28/1556429167175766.jpg
     * @author lastwhisper
     * @Param objectName
     */
    @RequestMapping("file/delete")
    @ResponseBody
    public FileUploadResult delete(@RequestParam("fileName") String objectName)
            throws Exception {
        return this.fileUploadService.delete(objectName);
    }

    /**
     * @author lastwhisper
     * @desc 查詢oss上的所有文件
     * http://localhost:8080/file/list
     * @return List<OSSObjectSummary>
     * @Param
     */
    @RequestMapping("file/list")
    @ResponseBody
    public List<OSSObjectSummary> list()
            throws Exception {
        return this.fileUploadService.list();
    }

    /**
     * @author lastwhisper
     * @desc 根據(jù)文件名下載oss上的文件
     * @return
     * @Param objectName
     */
    @RequestMapping("file/download")
    @ResponseBody
    public void download(@RequestParam("fileName") String objectName, HttpServletResponse response) throws IOException {
        //通知瀏覽器以附件形式下載
        response.setHeader("Content-Disposition",
                "attachment;filename=" + new String(objectName.getBytes(), "ISO-8859-1"));
        this.fileUploadService.exportOssFile(response.getOutputStream(),objectName);
    }
}

5. 前端頁面編寫與測試

5.1 文件上傳頁面

使用ajax異步文件上傳到后端對接的OSS上。

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">

    <title>oss文件上傳</title>
    <script type="text/javascript" src="https://cdn.bootcss.com/jquery/1.11.2/jquery.js"></script>
    <script>
        function uploadfile() {
            $("#fileTypeError").html('');
            //獲得文件名稱
            var fileName = $('#file_upload').val();
            //截取文件類型,如(.jpg)                
            var fileType = fileName.substr(fileName.length - 4, fileName.length);
            if (fileType == '.bmp' || fileType == '.jpg' || fileType == '.jpeg' || fileType == '.gif' || fileType == '.png') {     //驗證文件類型,此處驗證也可使用正則
                $.ajax({
                    url: 'file/upload',//上傳地址
                    type: 'POST',
                    cache: false,
                    data: new FormData($('#uploadForm')[0]),//表單數(shù)據(jù)
                    processData: false,
                    contentType: false,
                    success: function (rtn) {
                        if (rtn.status == 'error') {
                            $("#fileTypeError").html('*上傳文件類型錯誤,支持類型:  .bmp .jpg .jpeg .gif .png');  //根據(jù)后端返回值,回顯錯誤信息
                        } else {
                            $('div').append('<img src="' + rtn.name + '" style="width: 300px;height: 300px"></img>')
                        }
                    }
                });
            } else {
                $("#fileTypeError").html('*上傳文件類型錯誤,支持類型: .bmp .jpg .jpeg .gif .png');
            }
        }
    </script>
</head>
<body>
<form id="uploadForm" enctype="multipart/form-data">  <!-- 聲明文件上傳 -->
    <input id="file_upload" type="file" name="file"/>  <!-- 定義change事件,選擇文件后觸發(fā) -->
    <br/><span style="color: red" id="fileTypeError"></span>    <!-- 文件類型錯誤回顯,此處通過前后端兩次驗證文件類型 -->
    <br/><input type="button" onclick="uploadfile()" value="上傳">
</form>
<div></div>
</body>
</html>

效果展示:

ajax文件上傳到OSS
ajax文件上傳到OSS
ajax文件上傳到OSS成功

5.2 文件管理頁面

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>oss文件管理</title>
    <script type="text/javascript" src="https://cdn.bootcss.com/jquery/1.11.2/jquery.js"></script>
    <script type="text/javascript">
        var pre = 'https://gaojun-testbucket.oss-cn-shanghai.aliyuncs.com/';
        $(function () {
            listfile();
        });

        //文件列表
        function listfile() {
            $.ajax({
                url: "http://localhost:8080/file/list",
                type: 'POST',
                success: function (rtn) {
                    console.log(rtn.length);
                    for (var i = 0; i < rtn.length; i++) {
                        $('div').append('<img src="' + pre + rtn[i].key + '" style="width: 300px;height: 300px; padding: 10px" ondblclick="deletefile(this.src)" onclick="downloadfile(this.src)"></img>')
                    }
                }
            });
        }

        //文件下載
        function downloadfile(src) {

            var fileName = src.split(pre)[1];
            window.location.href = "http://localhost:8080/file/download?fileName=" + fileName;
        }

        //文件刪除
        function deletefile(src) {
            var fileName = src.split(pre)[1];
            var param = {fileName: fileName};
            $.ajax({
                url: "http://localhost:8080/file/delete",
                data: param,
                success: function () {
                    alert('刪除成功',fileName);
                    //刪除頁面
                    location.reload();
                }
            });
        }

    </script>
</head>
<body>
單擊下載oss上的圖片炭剪、雙擊刪除oss上的圖片<br>
<div>

</div>
</body>
</html>

效果展示:

剛才上傳了一張照片练链,可以立馬看到

文件管理

單擊頁面即可下載圖片

image.png

雙擊即可刪除圖片:

刪除圖片
刪除圖片
最后編輯于
?著作權歸作者所有,轉載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市奴拦,隨后出現(xiàn)的幾起案子媒鼓,更是在濱河造成了極大的恐慌,老刑警劉巖错妖,帶你破解...
    沈念sama閱讀 207,113評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件绿鸣,死亡現(xiàn)場離奇詭異,居然都是意外死亡暂氯,警方通過查閱死者的電腦和手機潮模,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,644評論 2 381
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來痴施,“玉大人擎厢,你說我怎么就攤上這事±背裕” “怎么了动遭?”我有些...
    開封第一講書人閱讀 153,340評論 0 344
  • 文/不壞的土叔 我叫張陵,是天一觀的道長神得。 經(jīng)常有香客問我厘惦,道長,這世上最難降的妖魔是什么哩簿? 我笑而不...
    開封第一講書人閱讀 55,449評論 1 279
  • 正文 為了忘掉前任宵蕉,我火速辦了婚禮,結果婚禮上节榜,老公的妹妹穿的比我還像新娘国裳。我一直安慰自己,他們只是感情好全跨,可當我...
    茶點故事閱讀 64,445評論 5 374
  • 文/花漫 我一把揭開白布缝左。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪渺杉。 梳的紋絲不亂的頭發(fā)上蛇数,一...
    開封第一講書人閱讀 49,166評論 1 284
  • 那天,我揣著相機與錄音是越,去河邊找鬼耳舅。 笑死,一個胖子當著我的面吹牛倚评,可吹牛的內(nèi)容都是我干的浦徊。 我是一名探鬼主播,決...
    沈念sama閱讀 38,442評論 3 401
  • 文/蒼蘭香墨 我猛地睜開眼天梧,長吁一口氣:“原來是場噩夢啊……” “哼盔性!你這毒婦竟也來了?” 一聲冷哼從身側響起呢岗,我...
    開封第一講書人閱讀 37,105評論 0 261
  • 序言:老撾萬榮一對情侶失蹤冕香,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后后豫,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體悉尾,經(jīng)...
    沈念sama閱讀 43,601評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 36,066評論 2 325
  • 正文 我和宋清朗相戀三年挫酿,在試婚紗的時候發(fā)現(xiàn)自己被綠了构眯。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片伍掀。...
    茶點故事閱讀 38,161評論 1 334
  • 序言:一個原本活蹦亂跳的男人離奇死亡凯旭,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出温赔,到底是詐尸還是另有隱情拄衰,我是刑警寧澤它褪,帶...
    沈念sama閱讀 33,792評論 4 323
  • 正文 年R本政府宣布,位于F島的核電站翘悉,受9級特大地震影響茫打,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜妖混,卻給世界環(huán)境...
    茶點故事閱讀 39,351評論 3 307
  • 文/蒙蒙 一老赤、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧制市,春花似錦抬旺、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,352評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽汉柒。三九已至,卻和暖如春责鳍,著一層夾襖步出監(jiān)牢的瞬間碾褂,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 31,584評論 1 261
  • 我被黑心中介騙來泰國打工历葛, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留正塌,地道東北人。 一個月前我還...
    沈念sama閱讀 45,618評論 2 355
  • 正文 我出身青樓恤溶,卻偏偏與公主長得像乓诽,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子咒程,可洞房花燭夜當晚...
    茶點故事閱讀 42,916評論 2 344

推薦閱讀更多精彩內(nèi)容