Hướng dẫn dùng thư viện angular file upload

Lightweight Angular directive để upload các file. Bạn có thể xem Demo để hiểu rõ hơn. Các phiên bản đã có: version 3.0.x, version 3.1.x, version 3.2.x, version 4.x.x, version 5.x.x, version 6.x.x, version 6.2.x, version 7.0.x, version 7.2.x, version 8.0.x, version 9.0.x, version 10.0.x, version 11.0.x, version 12.0.x, version 12.1.x, version 12.2.x

Nội dung sẽ trình bày bao gồm:

  • Các tính năng
  • Cài đặt (bằng tay, Bower, NuGet, NPM)
  • Các sử dụng
  • Trên các trình duyệt cũ

Tính năng

  • Upload file, xóa file
  • Kéo thả file (chỉ với html5)
  • Paste ảnh từ clipboard và kéo thả từ các trình duyệt khác (chỉ html5)
  • Thay đổi kích thước ảnh, center crop và người dùng có thể điều khiển crop thông qua ngImgCrop. Nhìn ví dụ ở crop sample (chỉ html5)
  • Sửa orientation cho các file ảnh jpeg cùng với dữ liệu exif orientation
  • Tải lên gián đoạn: Dừng lại/tiếp tục tải lên (chỉ trên html5)
  • Hỗ trợ validate kiểu, kích thước, chiều dài, chiều cao và góc cạnh của ảnh, thời gian video, âm thanh. Sử dụng ng-required cùng với pluggable custom sync hoặc async validations.
  • Trình diễn hình ảnh thu nhỏ hoặc là xem trước các lựa chọn hình ảnh/âm thanh/video.
  • Hỗ trợ CORS và tải lên trực tiếp tập tin dữ liệu nhị phân sử dụng Upload.$http()
  • Có sẵn trên npm, bower, meteor, nuget.
  • Phụ thuộc vào Flash FileAPI shim để tải lên nhưng không hỗ trợ trên trình duyệt html5

Cài đặt

  • Cài đặt bằng tay: Tải về tại đây
  • Cài đặt bằng brower
    • bower install ng-file-upload-shim --save(không hỗ trợ html5)
    • bower install ng-file-upload --save
  • Cài đặt bằng nuget: PM> Install-Package angular-file-upload
  • Cài đặt bằng npm: npm install ng-file-upload


 

Cách sử dụng

  • Tải lên cùng với form submit và validations: http://jsfiddle.net/danialfarid/maqbzv15/1118/
  • Tải lên nhiều file(từng file một) bởi một lần lựa chọn: http://jsfiddle.net/danialfarid/2vq88rfs/136/
  • Tải lên nhiều file(tất cả các file) bởi một lần lựa chọn(chỉ trên html5): http://jsfiddle.net/danialfarid/huhjo9jm/5/
  • Tải lên một file duy nhất bởi một lần lựa chọn: http://jsfiddle.net/danialfarid/0mz6ff9o/135/
  • Thả và tải lên cùng với $watch: http://jsfiddle.net/danialfarid/s8kc7wg0/400/
  • Crop ảnh và tải lên: http://jsfiddle.net/danialfarid/xxo3sk41/590/





Tải lên từ form submit hoặc button click
validation mỗi ảnh tải lên
Select
Tải nhiều files
Select
Drop files:
Drop
Upload right away after file selection:
Upload on file select
Upload on file select
Drop File:
Kéo thả ảnh hoặc file PDF ở đây
Kéo thả file không được hỗ trợ trên trình duyệt
Thu nhỏ ảnh: Xem trước Video:

Javascript code:

//inject trong directives và services.
var app = angular.module('fileUpload', ['ngFileUpload']);
app.controller('MyCtrl', ['$scope', 'Upload', function ($scope, Upload) {
    // Tải file lên sau khi ấn nút submit
    $scope.submit = function() {
      if ($scope.form.file.$valid && $scope.file) {
        $scope.upload($scope.file);
      }
    };
    // Tải file lên hoặc kéo thả
    $scope.upload = function (file) {
        Upload.upload({
            url: 'upload/url',
            data: {file: file, 'username': $scope.username}
        }).then(function (resp) {
            console.log('Success ' + resp.config.data.file.name + 'uploaded. Response: ' + resp.data);
        }, function (resp) {
            console.log('Error status: ' + resp.status);
        }, function (evt) {
            var progressPercentage = parseInt(100.0 * evt.loaded / evt.total);
            console.log('progress: ' + progressPercentage + '% ' + evt.config.data.file.name);
        });
    };
    // Đối việc upload nhiều file:
    $scope.uploadFiles = function (files) {
      if (files && files.length) {
        for (var i = 0; i < files.length; i++) {
          Upload.upload({..., data: {file: files[i]}, ...})...;
        }
        // Hoặc là gửi tất cả cùng với trình duyệt HTML5:
        Upload.upload({..., data: {file: files}, ...})...;
      }
    }
}]);

Tài liệu tham khảo đầy đủ

Lựa chọn và kéo thả file

Ít nhất một trong các ngf-select hoặc ngf-drop là bắt buộc đối với plugin để liên kết đến các phần tử. Chỉ các thuộc tính ngf-select được đánh dấu * và chỉ các thuộc tính ngf-drop được đánh dấu +

Upload/Drop
File Drag/drop is not supported // filter to convert the file to base64 data url. image

Xem trước file



Upload service:

var upload = Upload.upload({
  *url: 'server/upload/url', // upload.php script, node.js route, or servlet url
  /*
  Specify the file and optional data to be sent to the server.
  Each field including nested objects will be sent as a form data multipart.
  Samples: {pic: file, username: username}
    {files: files, otherInfo: {id: id, person: person,...}} multiple files (html5)
    {profiles: {[{pic: file1, username: username1}, {pic: file2, username: username2}]} nested array multiple files (html5)
    {file: file, info: Upload.json({id: id, name: name, ...})} send fields as json string
    {file: file, info: Upload.jsonBlob({id: id, name: name, ...})} send fields as json blob, 'application/json' content_type
    {picFile: Upload.rename(file, 'profile.jpg'), title: title} send file with picFile key and profile.jpg file name*/
  *data: {key: file, otherInfo: uploadInfo},
  /*
  This is to accommodate server implementations expecting nested data object keys in .key or [key] format.
  Example: data: {rec: {name: 'N', pic: file}} sent as: rec[name] -> N, rec[pic] -> file
     data: {rec: {name: 'N', pic: file}}, objectKey: '.k' sent as: rec.name -> N, rec.pic -> file */
  objectKey: '[k]' or '.k' // default is '[k]'
  /*
  This is to accommodate server implementations expecting array data object keys in '[i]' or '[]' or
  ''(multiple entries with same key) format.
  Example: data: {rec: [file[0], file[1], ...]} sent as: rec[0] -> file[0], rec[1] -> file[1],...
    data: {rec: {rec: [f[0], f[1], ...], arrayKey: '[]'} sent as: rec[] -> f[0], rec[] -> f[1],...*/
  arrayKey: '[i]' or '[]' or '.i' or '' //default is '[i]'
  method: 'POST' or 'PUT'(html5), default POST,
  headers: {'Authorization': 'xxx'}, // only for html5
  withCredentials: boolean,
  /*
  See resumable upload guide below the code for more details (html5 only) */
  resumeSizeUrl: '/uploaded/size/url?file=' + file.name // uploaded file size so far on the server.
  resumeSizeResponseReader: function(data) {return data.size;} // reads the uploaded file size from resumeSizeUrl GET response
  resumeSize: function() {return promise;} // function that returns a prommise which will be
                                            // resolved to the upload file size on the server.
  resumeChunkSize: 10000 or '10KB' or '10MB' // upload in chunks of specified size
  disableProgress: boolean // default false, experimental as hotfix for potential library conflicts with other plugins
  ... and all other angular $http() options could be used here.
})
// returns a promise
upload.then(function(resp) {
  // file is uploaded successfully
  console.log('file ' + resp.config.data.file.name + 'is uploaded successfully. Response: ' + resp.data);
}, function(resp) {
  // handle error
}, function(evt) {
  // progress notify
  console.log('progress: ' + parseInt(100.0 * evt.loaded / evt.total) + '% file :'+ evt.config.data.file.name);
});
upload.catch(errorCallback);
upload.finally(callback, notifyCallback);
/* access or attach event listeners to the underlying XMLHttpRequest */
upload.xhr(function(xhr){
  xhr.upload.addEventListener(...)
});
/* cancel/abort the upload in progress. */
upload.abort();
/*
alternative way of uploading, send the file binary with the file's content-type.
Could be used to upload files to CouchDB, imgur, etc... html5 FileReader is needed.
This is equivalent to angular $http() but allow you to listen to the progress event for HTML5 browsers.*/
Upload.http({
  url: '/server/upload/url',
  headers : {
    'Content-Type': file.type
  },
  data: file
})
/* Set the default values for ngf-select and ngf-drop directives*/
Upload.setDefaults({ngfMinSize: 20000, ngfMaxSize:20000000, ...})
// These two defaults could be decreased if you experience out of memory issues
// or could be increased if your app needs to show many images on the page.
// Each image in ngf-src, ngf-background or ngf-thumbnail is stored and referenced as a blob url
// and will only be released if the max value of the followings is reached.
Upload.defaults.blobUrlsMaxMemory = 268435456 // default max total size of files stored in blob urls.
Upload.defaults.blobUrlsMaxQueueSize = 200 // default max number of blob urls stored by this application.
/* Convert a single file or array of files to a single or array of
base64 data url representation of the file(s).
Could be used to send file in base64 format inside json to the databases */
Upload.base64DataUrl(files).then(function(urls){...});
/* Convert the file to blob url object or base64 data url based on boolean disallowObjectUrl value */
Upload.dataUrl(file, boolean).then(function(url){...});
/* Get image file dimensions*/
Upload.imageDimensions(file).then(function(dimensions){console.log(dimensions.width, dimensions.height);});
/* Get audio/video duration*/
Upload.mediaDuration(file).then(function(durationInSeconds){...});
/* Resizes an image. Returns a promise */
// options: width, height, quality, type, ratio, centerCrop, resizeIf, restoreExif
//resizeIf(width, height) returns boolean. See ngf-resize directive for more details of options.
Upload.resize(file, options).then(function(resizedFile){...});
/* returns boolean showing if image resize is supported by this browser*/
Upload.isResizeSupported()
/* returns boolean showing if resumable upload is supported by this browser*/
Upload.isResumeSupported()
/* returns a file which will be uploaded with the newName instead of original file name */
Upload.rename(file, newName)
/* converts the object to a Blob object with application/json content type
for jsob byte streaming support 
# 359 (html5 only)*/
Upload.jsonBlob(obj)
/* converts the value to json to send data as json string. Same as angular.toJson(obj) */
Upload.json(obj)
/* converts a dataUrl to Blob object.*/
var blob = upload.dataUrltoBlob(dataurl, name);
/* returns true if there is an upload in progress. Can be used to prompt user before closing browser tab */
Upload.isUploadInProgress() boolean
/* downloads and converts a given url to Blob object which could be added to files model */
Upload.urlToBlob(url).then(function(blob) {...});
/* returns boolean to check if the object is file and could be used as file in Upload.upload()/http() */
Upload.isFile(obj);
/* fixes the exif orientation of the jpeg image file*/
Upload.applyExifRotation(file).then(...)

Giá trị ng-model sẽ là một file duy nhất thay vì một mảng nếu tất cả các điều sau đây là đúng:

  • ngf-multiple không được set hoặc là có giá trị false.
  • Thuộc tính multiple không được set trên các phần tử
  • ngf-keep không được set hoặc là có giá trị false.

Trên các trình duyệt cũ

Đối với các trình duyệt không hỗ trợ HTML5 FormData (IE8, IE9, ...) thì module FileAPI sẽ được sử dụng. Lưu ý: bạn cần cài thêm Flash trên browser khi FileAPI sử dụng Flash tải file.

Hai file FileAPI.min.js, FileAPI.flash.swf sẽ được load bởi các module theo yêu cầu (không cần phải được include trong html) nếu trình duyệt không hỗ trợ HTML5 FormData. Bạn có thể thay thế hai file trên bởi file angular-file-upload-shim(.min).js. Trên server của bạn sẽ được load tự động theo cùng một cách hoặc bạn có thể định nghĩa đường dẫn đến các file này, nếu các đường dẫn là khác nhau bạn có thể sử dụng theo script: