Asp.net core 2.0 +SPA文件上传注意事项

最近在做的一个工程,后端选用asp.net 2.0 core,前端用vue。选用core纯粹是好奇,想体验一下微软的新技术。还有就是实在不想写java...。技术组成如下:

  • 后端:asp.net core 2.0 +JWT Auth + mongodb + RESTFul + swagger
  • 前端:Vue + Vuetify
    一开始一切都算顺利,可是到了文件上传环节,遇到了一点小挫折(掩面,其实是耽误了一天半时间),现在记录一下:
  1. 前端上传方式选择:
    首先根据微软官网文档,asp.net core文件上传示例全部用的是表单+Razor的方式,后台用IFormFile接收。顺便吐槽一下,感觉微软总是慢半拍啊,整个core的介绍全都是MVC例子,没有RESTFul的,数据库全都是SQL。没有NoSQL。
    SPA文件上传肯定不能用表单提交,那么可以选择的合理方式有:
  • axios
  • HTML5 原生XMLHttpRequest
  • jquery
  • 各种封装好的第三方库(如vue-upload-componen)

以下对各种方式进行实验:

后端--------------------------

        [HttpPost("test")]
        public AppResponse UploadTest(IFormFile file)
        {
            if (file==null)
            {
                return responser.ReturnError(STATUS_CODE.BAD_REQUEST, "files is empty");
            }
            return responser.ReturnSuccess(extraInfo: file.FileName);
        }

关于文件上传,官方有一段文字解释如下:

If your controller is accepting uploaded files using IFormFile but you find that the value is always null, confirm that your HTML form is specifying an enctype value of multipart/form-data. If this attribute is not set on the <form> element, the file upload will not occur and any bound IFormFile arguments will be null.

意思就是说,上传文件的表单必须设置enctype=multipart/form-data,否则是取不到值的。

但如果是以非表单方式上传,前台应该怎么做?

前端-----------------------------

前台搭建以下简单页面:

<template>
<v-card>
<h1>UPLOAD</h1>
<v-divider></v-divider>
<input type="file" ref="f" />
<v-btn @click.native="uploadOnXMLHttpRequest">使用XMLHttpRequest上传</v-btn>
<v-btn @click.native="uploadOnAxios">使用axios上传</v-btn> 
</v-card>

</template>
  1. 首先说axios,经过实验,无法上传文件到.net core后台:
 uploadOnAxios() {
      const options = {
        url: this.url,
        method: 'post',
        data: {
          'file': this.$refs.f.files[0]
        },
     //   headers: { 'Content-Type': undefined }//无效
        //  headers: { 'Content-Type': 'multipart/form-data' }//无效
      }
      this.$http.request(options).then(res => {
        console.log(res)
      })
    },

上面注释掉的两个header,就是试图设置enctype,其实就是表单header里的content-type,经过测试,都没有效果,axios始终发送:application/json。后台因此拿不到值。

  1. HTML5 原生XMLHttpRequest
    首先是关于浏览器支持,这个要看工程,比如我这个工程,都用到vue和vuetify了,就不考虑兼容性了,放心大胆使用就行。
  uploadOnXMLHttpRequest() {
      const fileObj = this.$refs.f.files[0] // js 获取文件对象
      var url = this.url // 接收上传文件的后台地址
      var form = new FormData() // FormData 对象
      form.append('file', fileObj) // 文件对象

      const xhr = new XMLHttpRequest()  // XMLHttpRequest 对象
      xhr.open('post', url, true) // post方式,url为服务器请求地址,true 该参数规定请求是否异步处理。
     // xhr.setRequestHeader('Content-Type', undefined)
      xhr.onload = (evt) => {
        var data = JSON.parse(evt)
        if (data.status) {
          alert('上传成功!')
        } else {
          alert('上传失败!')
        }
      } // 请求完成
      xhr.onerror = (x) => {
        alert('failed:' + JSON.parse(x))
      } // 请求失败
      xhr.onprogress = (x) => {
        console.log(`uploading...${x}%`)
      } // 请求失败
      xhr.send(form) // 开始上传,发送form数据
    },

经测试,可以上传,注意xhr.setRequestHeader('Content-Type', undefined)被注释掉了,实际上这时XMLHttpRequest能自动设置content-type,这句加了反倒会报错。

  1. jquery
    我没有直接在vue项目中测试jquery,是在一个纯静态html中测试的,使用到了jQuery和query.form插件:
<!doctype html>

<head>
  <title>File Upload Progress Demo #2</title>
  <style>
    body {
      padding: 30px
    }

    form {
      display: block;
      margin: 20px auto;
      background: #eee;
      border-radius: 10px;
      padding: 15px
    }

    .progress {
      position: relative;
      width: 400px;
      border: 1px solid #ddd;
      padding: 1px;
      border-radius: 3px;
    }

    .bar {
      background-color: #B4F5B4;
      width: 0%;
      height: 20px;
      border-radius: 3px;
    }

    .percent {
      position: absolute;
      display: inline-block;
      top: 3px;
      left: 48%;
    }
  </style>
</head>

<body>
  <h1>File Upload Progress Demo #2</h1>
  <code>&lt;input type="file" name="myfile[]" multiple></code>
  <form action="http://localhost:5000/api/document/test" method="post" enctype="multipart/form-data">
    <input type="file" name="files" multiple>
    <br>
    <input type="submit" value="Upload File to Server">
  </form>

  <div class="progress">
    <div class="bar"></div>
    <div class="percent">0%</div>
  </div>

  <div id="status"></div>

  <script src="https://cdn.bootcss.com/jquery/1.7.2/jquery.min.js"></script>
  <script src="https://cdn.bootcss.com/jquery.form/3.36/jquery.form.min.js"></script>
  <script>
    (function () {

      var bar = $('.bar');
      var percent = $('.percent');
      var status = $('#status');

      $('form').ajaxForm({
        beforeSend: function () {
          status.empty();
          var percentVal = '0%';
          bar.width(percentVal)
          percent.html(percentVal);
        },
        uploadProgress: function (event, position, total, percentComplete) {
          var percentVal = percentComplete + '%';
          bar.width(percentVal)
          percent.html(percentVal);
          //console.log(percentVal, position, total);
        },
        success: function () {
          var percentVal = '100%';
          bar.width(percentVal)
          percent.html(percentVal);
        },
        complete: function (xhr) {
          status.html(xhr.responseText);
        }
      });

    })();
  </script>


结果:可以上传,这个应该没问题,因为本来就是一个表单上传啊~~,query.form的作用是使用了一个隐藏的iframe。上传后刷新的其实是这个iframe,所以用户感觉不到页面刷新。
虽然实现了,但个人并不喜欢这种hack的写法。jQuery应该退出历史舞台了。也算功成名就。还有,在vue中使用jQuery也不是很难,但总感觉不伦不类。

  1. 其他库:
    这些库功能很多,但个人不建议使用,一来很多功能用不上,二来其底层实现不好控制

总结:

我最后选择了 HTML5 XMLHttpRequest 在asp.net core中上传文件,原生模块,灵活方便,随便就能写出一个个人定制的不错的上传组件。

补充

其实,把上传的文件和程序放在同一个服务器不是很好的做法,完全可以建一个资源服务器进行隔离,以下是用 express和multer建立的一个简单上传文件后台:

var express = require('express')
var multer  = require('multer')
var upload = multer({ dest: 'uploads/' })

var app = express()

//allow custom header and CORS
app.all('*',function (req, res, next) {
  res.header('Access-Control-Allow-Origin', '*');
  res.header('Access-Control-Allow-Headers', 'Content-Type, Content-Length, Authorization, Accept, X-Requested-With , yourHeaderFeild');
  res.header('Access-Control-Allow-Methods', 'PUT, POST, GET, DELETE, OPTIONS');

  if (req.method == 'OPTIONS') {
    res.send(200); //让options请求快速返回/
  }
  else {
    next();
  }
}); 

app.post('/profile', upload.single('file'), function (req, res, next) {
  const file = req.file
  const body = req.body
  res.send('ok,uploaded')
  next()
  // req.body will hold the text fields, if there were any
})

app.post('/photos/upload', upload.array('photos', 12), function (req, res, next) {
  // req.files is array of `photos` files
  // req.body will contain the text fields, if there were any
})

var cpUpload = upload.fields([{ name: 'avatar', maxCount: 1 }, { name: 'gallery', maxCount: 8 }])
app.post('/cool-profile', cpUpload, function (req, res, next) {
  // req.files is an object (String -> Array) where fieldname is the key, and the value is array of files
  //
  // e.g.
  //  req.files['avatar'][0] -> File
  //  req.files['gallery'] -> Array
  //
  // req.body will contain the text fields, if there were any
})

var server = app.listen(3000, function () {
    var host = server.address().address;
    var port = server.address().port;
  
    console.log('Example app listening at http://%s:%s', host, port);
  });

这样,上传文件到这个服务器后,拿到文件地址,再回来应用插入到数据库就行

当然,如果数据保密度不高,那用七牛是最简单的了

最近有个想法,出一个vue+core的工程管理系统(PMS)系列教程,各位喜欢就点个赞吧,我看着赞多了就开始写(_)

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,839评论 6 482
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,543评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 153,116评论 0 344
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,371评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,384评论 5 374
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,111评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,416评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,053评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,558评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,007评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,117评论 1 334
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,756评论 4 324
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,324评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,315评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,539评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,578评论 2 355
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,877评论 2 345

推荐阅读更多精彩内容