1. 程式人生 > >Asp.Net Core Web Api圖片上傳(一)整合MongoDB儲存例項教程

Asp.Net Core Web Api圖片上傳(一)整合MongoDB儲存例項教程

Asp.Net Core Web Api圖片上傳及MongoDB儲存例項教程(一)

圖片或者檔案上傳相信大家在開發中應該都會用到吧,有的時候還要對圖片生成縮圖。那麼如何在Asp.Net Core Web Api實現圖片上傳儲存以及生成縮圖呢?今天我就使用MongoDB作為圖片儲存,然後使用SixLabors作為圖片處理,通過一個Asp.Net Core Web Api例項來給大家講解下!本文有點長,可以先收藏推薦然後再看!
本文地址:https://www.cnblogs.com/yilezhu/p/9297009.html
作者:yilezhu

寫在前面

閱讀本文章,需要你具備asp.net core的基礎知識,至少能夠建立一個Asp.Net Core Web Api專案吧!其次,我不會跟你說MongoDB是什麼以及為什麼選擇MongoDB作為檔案儲存這樣的問題,因為百度百科已經給你說了, MongoDB 是一個基於分散式檔案儲存的資料庫。實在不清楚的話自己去看百度百科吧!

MongoDB在Windows下的下載安裝以及配置

MongoDB下載

下載之後一路next基本就能完成。當然還是給新手朋友一些圖文操作吧。已經會安裝的朋友可以跳過這一節往下看。

MongoDB安裝

MongoDB服務配置

一路next,然後安裝出現最後安裝成功的介面,點選Finish即可。

MongoDB安裝完成

然後,Win+R 執行,輸入services.msc 然後輸入Enter鍵。開啟如下的服務視窗

MongoDB服務
雙擊上面圈起來的MongoDB服務,可以看到如下引數命令

MongoDB啟動引數

"C:\Program Files\MongoDB\Server\4.0\bin\mongod.exe" --config "C:\Program Files\MongoDB\Server\4.0\bin\mongod.cfg" --service

上面表示,MongoDB作為服務的方式進行啟動,並且按照 --Config後面的路徑裡面的配置檔案裡的配置進行啟動。

我們找到這個配置檔案,並開啟看下吧!

MongoDB配置

你可以重新設定引數後,然後重新啟動服務即可生效!
最後,讓我們瀏覽器開啟上面設定的IP以及埠號檢視一下,如下圖所示,表示MongoDB安裝成功!

MongoDB安裝成功

Asp.Net Core Web Api圖片上傳的程式碼實現

  1. 新建Asp.Net Core Web Api專案
    這裡我不會教你怎麼建立一個Asp.Net Core Web Api專案了。建立好後會出現如下圖所示的結構

目錄結構

  1. 安裝MongoDB的nuget包以及SixLabors圖片處理的包

    Install-Package MongoDB.Bson -Version 2.7.0
    Install-Package MongoDB.Driver -Version 2.7.0
    Install-Package SixLabors.ImageSharp -Version 1.0.0-beta0004
    Install-Package SixLabors.ImageSharp.Drawing -Version 1.0.0-beta0004
  2. 在appsettings.json中加入MongoDBHost的配置,如下所示,埠以及ip上面我們已經配置過了

    {
      "Logging": {
        "LogLevel": {
          "Default": "Warning"
        }
      },
      "MongodbHost": {
        "Connection": "mongodb://127.0.0.1:27017",
        "DataBase": "File_Server",
        "Table": ""
      },
      "PictureOptions": {
        "FileTypes": ".gif,.jpg,.jpeg,.png,.bmp,.GIF,.JPG,.JPEG,.PNG,.BMP",
        "MaxSize": 1048576,
        "ThumsizeW": 200,
        "ThumsizeH": 140,
        "MakeThumbnail": true,
        "ThumbnailGuidKeys": "yilezhu",
        "ImageBaseUrl": "http://localhost:5002/api/Picture/Show/"
      }
    }
    
  3. 既然有了配置,肯定要建立對應的Options了。MongodbHostOptions以及PictureOptions的程式碼如下所示:

   public class MongodbHostOptions
    {
        /// <summary>
        /// 連線字串
        /// </summary>
        public string Connection { get; set; }
        /// <summary>
        /// 庫
        /// </summary>
        public string DataBase { get; set; }
        /// <summary>
        /// 表
        /// </summary>
        public string Table { get; set; }
    }

    public class PictureOptions
    {
        /// <summary>
        /// 允許的檔案型別
        /// </summary>
        public string FileTypes { get; set; }
        /// <summary>
        /// 最大檔案大小
        /// </summary>
        public int MaxSize { get; set; }
        /// <summary>
        /// 縮圖寬度
        /// </summary>
        public int ThumsizeW { get; set; }
        /// <summary>
        /// 縮圖高度
        /// </summary>
        public int ThumsizeH { get; set; }
        /// <summary>
        /// 是否縮圖
        /// </summary>
        public bool MakeThumbnail { get; set; }
        /// <summary>
        /// 圖片的基地址
        /// </summary>
        public string ImageBaseUrl { get; set; }
    }
  1. 服務註冊中進行注入
//MongodbHost資訊
services.Configure<MongodbHostOptions>(Configuration.GetSection("MongodbHost"));
//圖片選項
services.Configure<PictureOptions>(Configuration.GetSection("PictureOptions"));
  1. 新建一個PictureController用來作為圖片上傳的api,裡面包含圖片上傳介面,刪除介面,以及顯示介面,上傳接受一個base64的圖片字串,然後生成縮圖,然後儲存到MongoDB資料庫中,全部程式碼如下所示:

    using System;
    using System.Collections.Generic;
    using System.IO;
    using System.Linq;
    using System.Text;
    using System.Threading.Tasks;
    using Microsoft.AspNetCore.Http;
    using Microsoft.AspNetCore.Mvc;
    using Microsoft.Extensions.Options;
    using MongoDBDemo.Dtos;
    using MongoDBDemo.Helper;
    using MongoDBDemo.Models;
    using MongoDBDemo.Options;
    using MongoDBDemo.Result;
    
    namespace MongoDBDemo.Controllers
    {
    
        /// <summary>
        /// yilezhu
        /// 2018.7.10
        /// 圖片操作相關介面
        /// </summary>
        public class PictureController : BaseController
        {
            // MongodbHost資訊
            private readonly MongodbHostOptions _mongodbHostOptions;
    
            // 圖片選項
            private readonly PictureOptions _pictureOptions;
    
            /// <summary>
            /// 建構函式注入
            /// </summary>
            /// <param name="mongodbHostOptions">MongodbHost資訊</param>
            /// <param name="pictureOptions">圖片選項</param>
            public PictureController(IOptions<MongodbHostOptions> mongodbHostOptions, IOptions<PictureOptions> pictureOptions)
            {
                _mongodbHostOptions = mongodbHostOptions.Value;
                _pictureOptions = pictureOptions.Value;
            }
    
            /// <summary>
            /// 介面上傳圖片方法
            /// </summary>
            /// <param name="fileDtos">檔案傳輸物件,傳過來的json資料</param>
            /// <returns>上傳結果</returns>
            [HttpPost]
            public async Task<UploadResult> Post([FromBody] FileDtos fileDtos)
            {
                UploadResult result = new UploadResult();
                if (ModelState.IsValid)
                {
                    #region  驗證通過
                    //首先根據api引數判斷是否為圖片型別,是則處理,不是則返回對應的結果
                    if (!string.IsNullOrEmpty(fileDtos.Type) && fileDtos.Type.ToLower() == "image")
                    {
                        //檔案型別
                        string FileEextension = Path.GetExtension(fileDtos.Filename).ToLower();//獲取檔案的字尾
                                                                                               //判斷檔案型別是否是允許的型別
                        if (_pictureOptions.FileTypes.Split(',').Contains(FileEextension))
                        {
                            //圖片型別是允許的型別
                            Images_Mes fmster = new Images_Mes();//圖片儲存資訊類,跟MongoDB裡面表名一致
                            string fguid = Guid.NewGuid().ToString().Replace("-",""); //檔名稱
                            fmster.AddTime = DateTimeOffset.Now;//新增時間為當前時間
                            fmster.AddUser = "server";//具體根據你的業務來獲取
                            if (Base64Helper.IsBase64String(fileDtos.Base64String, out byte[] fmsterByte))
                            {
                                //判斷是否是base64字串,如果是則轉換為位元組陣列,用來儲存
                                fmster.FileCon = fmsterByte;
                            }
                            fmster.FileName = Path.GetFileName(fileDtos.Filename);//檔名稱
                            fmster.FileSize = fmster.FileCon.Length;//檔案大小
                            fmster.FileType = FileEextension;//副檔名
                            fmster.GuidID = fguid;//唯一主鍵,通過此來獲取圖片資料
                            await MongodbHelper<Images_Mes>.AddAsync(_mongodbHostOptions, fmster);//上傳檔案到mongodb伺服器
                                                                                                  //檢查是否需要生產縮圖
                            if (_pictureOptions.MakeThumbnail)
                            {
                                //生成縮圖
                                Images_Mes fthum = new Images_Mes();
                                fthum.AddTime = DateTimeOffset.Now;
                                fthum.AddUser = "server";//具體根據你的業務來獲取
                                fthum.FileCon = ImageHelper.GetReducedImage(fmster.FileCon, _pictureOptions.ThumsizeW, _pictureOptions.ThumsizeH);
                                fthum.FileName = Path.GetFileNameWithoutExtension(fileDtos.Filename) + "_thumbnail" + Path.GetExtension(fileDtos.Filename);//生成縮圖的名稱
                                fthum.FileSize = fthum.FileCon.Length;//縮圖大小
                                fthum.FileType = FileEextension;//縮圖副檔名
                                fthum.GuidID = fguid + _pictureOptions.ThumbnailGuidKeys;//為了方面,縮圖的主鍵為主圖主鍵+一個字元yilezhu作為主鍵
                                await MongodbHelper<Images_Mes>.AddAsync(_mongodbHostOptions, fthum);//上傳縮圖到mongodb伺服器
                            }
                            result.Errcode = ResultCodeAddMsgKeys.CommonObjectSuccessCode;
                            result.Errmsg = ResultCodeAddMsgKeys.CommonObjectSuccessMsg;
                            UploadEntity entity = new UploadEntity();
                            entity.Picguid = fguid;
                            entity.Originalurl = _pictureOptions.ImageBaseUrl + fguid;
                            entity.Thumburl = _pictureOptions.ImageBaseUrl + fguid + _pictureOptions.ThumbnailGuidKeys;
                            result.Data = entity;
                            return result;
                        }
                        else
                        {
                            //圖片型別不是允許的型別
                            result.Errcode = ResultCodeAddMsgKeys.HttpFileInvalidCode;//對應的編碼
                            result.Errmsg = ResultCodeAddMsgKeys.HttpFileInvalidMsg;//對應的錯誤資訊
                            result.Data = null;//資料為null
                            return result;
                        }
    
                    }
                    else
                    {
                        result.Errcode = ResultCodeAddMsgKeys.HttpFileNotFoundCode;
                        result.Errmsg = ResultCodeAddMsgKeys.HttpFileNotFoundMsg;
                        result.Data = null;
                        return result;
                    }
                    #endregion
                }
                else
                {
                    #region 驗證不通過
                    StringBuilder errinfo = new StringBuilder();
                    foreach (var s in ModelState.Values)
                    {
                        foreach (var p in s.Errors)
                        {
                            errinfo.AppendFormat("{0}||", p.ErrorMessage);
                        }
                    }
                    result.Errcode = ResultCodeAddMsgKeys.CommonModelStateInvalidCode;
                    result.Errmsg = errinfo.ToString();
                    result.Data = null;
                    return result;
                    #endregion
                }
            }
    
            /// <summary>
            /// 刪除圖片
            /// </summary>
            /// <param name="guid">原始圖片主鍵</param>
            /// <returns>執行結果</returns>
            [HttpDelete("{guid}")]
            public async Task<BaseResult> Delete(string guid)
            {
                await MongodbHelper<Images_Mes>.DeleteAsync(_mongodbHostOptions, guid);//刪除mongodb伺服器上對應的檔案
                await MongodbHelper<Images_Mes>.DeleteAsync(_mongodbHostOptions, guid + _pictureOptions.ThumbnailGuidKeys);//刪除mongodb伺服器上對應的檔案
                return new BaseResult(ResultCodeAddMsgKeys.CommonObjectSuccessCode, ResultCodeAddMsgKeys.CommonObjectSuccessMsg);
            }
    
            /// <summary>
            /// 返回圖片物件
            /// </summary>
            /// <param name="guid">圖片的主鍵</param>
            /// <returns>圖片物件</returns>
            [Route("Show/{guid}")]
            [HttpGet]
            public async Task<FileResult> ShowAsync(string guid)
            {
                if (string.IsNullOrEmpty(guid))
                {
                    return null;
                }
                FilterDefinition<Images_Mes> filter = Builders<Images_Mes>.Filter.Eq("GuidID", guid);
                var result= await MongodbHelper<Images_Mes>.FindListAsync(_mongodbHostOptions, filter);
                if (result != null && result.Count > 0)
                {
                    return File(result[0].FileCon, "image/jpeg", result[0].FileName);
                }
                else
                {
                    return null;
                }
    
            }
        }
    }
    1. 下面我們先連線下MongoDB看下里面內容如下:

      win7系統MongoDB操作軟體顯示有點問題,將就將就吧!

      MongoDB資料庫

  2. 開啟Postman進行圖片上傳操作,方法選擇“Post”,引數格式選擇json,然後輸入對應的引數格式,如下圖所示,都有標註,相信你都能看懂:

    PostMan測試

  3. 引數輸入完畢之後,最後點選右側的“Send”按鈕進行測試,看到如下所示的返回結果:

Postman測試結果

  1. 我們接下來利用工具查詢下MongoDB,看看有沒有生成對應的資料庫以及Collections如下圖所示,可以看到生成了我們定義的File_Server資料庫以及Images_Mes集合

    執行後的MongoDB資料庫

  2. 查詢下看看裡面的資料可以看到裡面的資料正是結果返回的資料,說明我們的結果是正確的,如下所示:

    MongoDB查詢結果

總結

教程已經寫完了,細心地朋友應該能夠看到,大部分程式碼都是昨天晚上寫的,今天晚上又稍加修改完成的!一篇文章足足消耗了兩個晚上,希望大家能多多支援!
總結中說了一句廢話!莫怪啊!本篇文章首先介紹了MongoDB的安裝,然後建立了一個新的Asp.Net Core Web Api專案,然後通過一個圖片上傳的例項來講述了Asp.Net Core中圖片上傳的操作,以及MongoDB作為圖片儲存的實現!當然中間用到了圖片縮圖的生成,最後寫了一個簡單地圖片展示。希望本篇關於Asp.Net Core Web Api圖片上傳及MongoDB儲存的例項教程能對大家使用Asp.Net Core Web Api進行圖片上傳以及MongoDB的使用有多幫助!
最後,還是希望大家多多推薦,多多支援!下面我會繼續完善下程式碼,加入IdentityServer認證,以及SwaggerUI實現介面文件,但是Ocelot閘道器技術以及consul實現服務發現以及故障的郵件傳送等等功能就不在此專案程式碼中應用了!