通过阅读本文,您可以了解文件上传的方式和基本流程。

操作步骤

  1. 请求上传地址和凭证或STS。
    说明 点播文件上传类VODUploadClient支持上传地址和凭证或STS方式上传,推荐使用上传地址和凭证方式进行上传。
    • 请求上传地址和凭证

      上传图片和上传视频获取上传地址和凭证所请求的API不同,如下所示:

      • 上传视频:客户端向AppServer发送请求,AppServer通过OpenAPI向阿里云点播服务发送CreateUploadVideo请求。请求成功将返回上传地址、上传凭证以及VideoId,AppServer将结果返回给客户端。
      • 上传图片:客户端向AppServer发送请求,AppServer通过OpenAPI向阿里云点播服务发送CreateUploadImage请求。请求成功将返回上传地址、上传凭证以及ImageURL,AppServer将结果返回给客户端。
    • 请求STS

      通过STS方式,客户端向AppServer发送请求,AppServer向阿里云STS服务请求临时STS凭证。请求成功将返回STS凭证,AppServer将结果返回给客户端。

  2. 初始化上传实例。
    1. 声明VODUploadClient属性,不能是局部变量。
      @property (nonatomic, strong) VODUploadClient *uploader;
    2. 初始化上传实例有两种方式,如下所示:
      • 上传地址和凭证方式

        上传地址和凭证方式调用init方法初始化。

        请求获取的上传地址和凭证初始化时无需设置,在开始上传开始后触发的OnUploadStartedListener回调中调用setUploadAuthAndAddress: uploadAuth:uploadAddress:方法进行设置。

        当token超时,会触发OnUploadTokenExpiredListener回调,需要调用resumeWithAuth方法,设置新的上传凭证继续上传。

        //create VODUploadClient object
        self.uploader = [VODUploadClient new];
        //weakself
        __weak typeof(self) weakSelf = self;
        //setup callback
        OnUploadFinishedListener FinishCallbackFunc = ^(UploadFileInfo* fileInfo, VodUploadResult* result){
            NSLog(@"upload finished callback videoid:%@, imageurl:%@", result.videoId, result.imageUrl);
        };
        OnUploadFailedListener FailedCallbackFunc = ^(UploadFileInfo* fileInfo, NSString *code, NSString* message){
            NSLog(@"upload failed callback code = %@, error message = %@", code, message);
        };
        OnUploadProgressListener ProgressCallbackFunc = ^(UploadFileInfo* fileInfo, long uploadedSize, long totalSize) {
            NSLog(@"upload progress callback uploadedSize : %li, totalSize : %li", uploadedSize, totalSize);
        };
        OnUploadTokenExpiredListener TokenExpiredCallbackFunc = ^{
            NSLog(@"upload token expired callback.");
            //token过期,设置新的上传凭证,继续上传
            [weakSelf.uploader resumeWithAuth:`new upload auth`];
        };
        OnUploadRertyListener RetryCallbackFunc = ^{
            NSLog(@"upload retry begin callback.");
        };
        OnUploadRertyResumeListener RetryResumeCallbackFunc = ^{
            NSLog(@"upload retry end callback.");
        };
        OnUploadStartedListener UploadStartedCallbackFunc = ^(UploadFileInfo* fileInfo) {
            NSLog(@"upload upload started callback.");
            //设置上传地址和上传凭证
            [weakSelf.uploader setUploadAuthAndAddress:fileInfo uploadAuth:`upload auth` uploadAddress:`upload address`];
        };
        VODUploadListener *listener = [[VODUploadListener alloc] init];
        listener.finish = FinishCallbackFunc;
        listener.failure = FailedCallbackFunc;
        listener.progress = ProgressCallbackFunc;
        listener.expire = TokenExpiredCallbackFunc;
        listener.retry = RetryCallbackFunc;
        listener.retryResume = RetryResumeCallbackFunc;
        listener.started = UploadStartedCallbackFunc;
        //init with upload address and upload auth
        [self.uploader init:listener];
      • STS方式

        STS方式调用init: accessKeySecret: secretToken: expireTime: listener方法初始化,初始化参数是请求获取的临时STS凭证。

        当token过期时,触发OnUploadTokenExpiredListener回调,需要调用resumeWithToken: accessKeySecret: secretToken: expireTime方法,设置新的STS继续上传。

        //create VODUploadClient object
        self.uploader = [VODUploadClient new];
        //weakself
        __weak typeof(self) weakSelf = self;
        //setup callback
        OnUploadFinishedListener FinishCallbackFunc = ^(UploadFileInfo* fileInfo,  VodUploadResult* result){
            NSLog(@"upload finished callback videoid:%@, imageurl:%@", result.videoId, result.imageUrl);
        };
        OnUploadFailedListener FailedCallbackFunc = ^(UploadFileInfo* fileInfo, NSString *code, NSString* message){
            NSLog(@"upload failed callback code = %@, error message = %@", code, message);
        };
        OnUploadProgressListener ProgressCallbackFunc = ^(UploadFileInfo* fileInfo, long uploadedSize, long totalSize) {
            NSLog(@"upload progress callback uploadedSize : %li, totalSize : %li", uploadedSize, totalSize);
        };
        OnUploadTokenExpiredListener TokenExpiredCallbackFunc = ^{
            NSLog(@"upload token expired callback.");
            //token过期,设置新的STS,继续上传
            [weakSelf.uploader resumeWithToken:`STS Key Id` accessKeySecret:`STS Key Secret` secretToken:`STS Secret Token` expireTime:`STS Expire Time`];
        };
        OnUploadRertyListener RetryCallbackFunc = ^{
            NSLog(@"upload retry begin callback.");
        };
        OnUploadRertyResumeListener RetryResumeCallbackFunc = ^{
            NSLog(@"upload retry end callback.");
        };
        OnUploadStartedListener UploadStartedCallbackFunc = ^(UploadFileInfo* fileInfo) {
            NSLog(@"upload upload started callback.");
        };
        //init
        VODUploadListener *listener = [[VODUploadListener alloc] init];
        listener.finish = FinishCallbackFunc;
        listener.failure = FailedCallbackFunc;
        listener.progress = ProgressCallbackFunc;
        listener.expire = TokenExpiredCallbackFunc;
        listener.retry = RetryCallbackFunc;
        listener.retryResume = RetryResumeCallbackFunc;
        listener.started = UploadStartedCallbackFunc;
        //init with STS
        [self.uploader init:`STS Key Id` accessKeySecret:`STS Key Secret` secretToken:STS Secret Token` expireTime:`STS Expire Time` listener:listener];
  3. 回调设置。

    设置VODUploadListener对象,该对象是上传状态的回调类,需要设置下列回调方法:

    /**
     上传完成回调
     @param fileInfo 上传文件信息
     @param result 上传结果信息
     */
    typedef void (^OnUploadFinishedListener) (UploadFileInfo* fileInfo, VodUploadResult* result);
    /**
     上传失败回调
     @param fileInfo 上传文件信息
     @param code 错误码
     @param message 错误描述
     */
    typedef void (^OnUploadFailedListener) (UploadFileInfo* fileInfo, NSString *code, NSString * message);
    /**
     上传进度回调
     @param fileInfo 上传文件信息
     @param uploadedSize 已上传大小
     @param totalSize 总大小
     */
    typedef void (^OnUploadProgressListener) (UploadFileInfo* fileInfo, long uploadedSize, long totalSize);
    /**
     token过期回调
     上传地址和凭证方式上传需要调用resumeWithAuth:方法继续上传
     STS方式上传需要调用resumeWithToken:accessKeySecret:secretToken:expireTime:方法继续上传
     */
    typedef void (^OnUploadTokenExpiredListener) ();
    /**
     上传开始重试回调
     */
    typedef void (^OnUploadRertyListener) ();
    /**
     上传结束重试,继续上传回调
     */
    typedef void (^OnUploadRertyResumeListener) ();
    /**
     开始上传回调
     上传地址和凭证方式上传需要调用setUploadAuthAndAddress:uploadAuth:uploadAddress:方法设置上传地址和凭证
     @param fileInfo 上传文件信息
     */
    typedef void (^OnUploadStartedListener) (UploadFileInfo* fileInfo);
  4. 添加文件到上传列表。
    • 添加文件
      • 添加视频
        NSString *filePath = [[NSBundle mainBundle] pathForResource:@"test" ofType:@"mp4"];
        VodInfo *vodInfo = [[VodInfo alloc] init];
        vodInfo.title = @"title";
        vodInfo.desc =@"desc";
        vodInfo.cateId = @(19);
        vodInfo.tags = @"sports";
        [self.uploader addFile:filePath vodInfo:vodInfo];
      • 添加图片
        NSString *filePath = [[NSBundle mainBundle] pathForResource:@"test" ofType:@"jpg"];
        VodInfo *imageInfo = [[VodInfo alloc] init];
        imageInfo.title = @"title";
        imageInfo.desc =@"desc";
        imageInfo.cateId = @(19);
        imageInfo.tags = @"sports";
        [self.uploader addFile:filePath vodInfo:imageInfo];
      说明 支持的文件不大于4 GB。
      VodInfo具体结构如下:
      //标题
      @property (nonatomic, copy) NSString* title;
      //标签
      @property (nonatomic, copy) NSString* tags;
      //描述
      @property (nonatomic, copy) NSString* desc;
      //分类ID
      @property (nonatomic, strong) NSNumber* cateId;
      //封面url(完整的URL https://)
      @property (nonatomic, copy) NSString* coverUrl;
      添加文件后,SDK会将待上传文件封装为UploadFileInfo对象,具体结构如下:
      //文件本地路径
      @property (nonatomic, copy) NSString* filePath;
      //endpoint
      @property (nonatomic, copy) NSString* endpoint;
      //bucket
      @property (nonatomic, copy) NSString* bucket;
      //object
      @property (nonatomic, copy) NSString* object;
      //VodInfo
      @property (nonatomic, strong) VodInfo* vodInfo;
    • 管理上传队列

      VODUploadClient支持添加多个文件顺序上传,并且提供了以下方法管理上传队列:

      说明 尽管VODUploadClient支持多文件上传,如果使用上传凭证和地址方式上传,每个文件还是需要单独设置。基于多文件上传代码复杂度的考虑,建议只添加单文件上传。
      • 从队列中删除上传文件,如果待删除的文件正在上传中,则取消上传并自动上传下一个文件。
        - (BOOL)deleteFile:(int) index;
      • 清空上传队列,如果有文件在上传,则取消上传。
        - (BOOL)clearFiles;
      • 获取上传文件队列。
        - (NSMutableArray<UploadFileInfo *> *)listFiles;
      • 将文件标记为取消,文件仍保留在上传列表中。如果待取消的文件正在上传中,则取消上传并自动上传下一个文件。
        - (BOOL)cancelFile:(int)index;
      • 恢复已取消的上传文件,并自动开始上传。
        - (BOOL)resumeFile:(int)index;
  5. 上传控制。
    • 开始上传。
      [self.uploader start];
      该方法调用后,会触发OnUploadStartedListener回调。如果通过上传地址和凭证方式上传,需要在该回调方法中设置上传地址和凭证。代码如下:
      [weakSelf.uploader setUploadAuthAndAddress:fileInfo uploadAuth:weakSelf.uploadAuth uploadAddress:weakSelf.uploadAddress];
    • 停止上传,如果有文件正在上传中,则取消上传。
      - (BOOL)stop;
      说明 停止上传后如需恢复上传,请调用resumeFile:恢复待上传文件,或者清空队列后重新添加文件上传。
    • 暂停上传。
      - (BOOL)pause;
    • 恢复上传。
      - (BOOL)resume;
  6. 回调处理。
    • 上传进度

      每上传一个分片,会触发OnUploadProgressListener回调,回调参数包括已上传文件大小uploadedSize和总文件大小totalSize

    • 上传成功

      上传成功时,会触发OnUploadFinishedListener回调。回调包含上传文件信息UploadFileInfo和上传结果VodUploadResultVodUploadResult包含以下属性:

      @property (nonatomic, copy) NSString* videoId;
      @property (nonatomic, copy) NSString* imageUrl;
      说明 videoId只在STS方式上传视频成功后才有返回值,imageUrl只在STS方式上传图片成功后才有返回值。如果使用上传地址和凭证方式上传,videoIdimageUrl不会返回,相应的值在请求上传地址和凭证时就可以获取到。

      视频上传成功后会返回videoId作为视频id,拿到videoId之后需要获取播放地址进行播放。更多信息,请参见获取播放地址播放

      图片上完成后会返回imageUrl,开启URL鉴权后imageUrl会有过期时间。更多信息,请参见URL鉴权

    • 上传失败

      上传失败时,会触发OnUploadFailedListener回调。在该回调方法中,可以通过codemessage查看具体原因,并在页面上提示。更多错误码信息,请参见错误码表OSS错误码

    • 凭证过期处理
      上传凭证或STS过期,会触发OnUploadTokenExpiredListener回调。在该回调方法中,可以向AppServer重新请求新的上传凭证或STS,并调用以下方法继续上传。
      • 重新设置上传凭证
        - (BOOL)resumeWithAuth:(NSString *)uploadAuth;
      • 重新设置STS
        - (BOOL)resumeWithToken:(NSString *)accessKeyId
                accessKeySecret:(NSString *)accessKeySecret
                    secretToken:(NSString *)secretToken
                     expireTime:(NSString *)expireTime;
    • 超时处理

      上传超时,会触发OnUploadRertyListener回调并自动重试。在该回调方法中,可以在页面上给予提示或者调用stop方法停止上传。此外,可以设置maxRetryCount属性,指定最大重试次数。超时重试可以继续上传时,会触发OnUploadRertyResumeListener回调并恢复上传。

高级设置

VODUploadClient支持以下高级设置。

/**
 上传文件到服务端是否转码,默认值YES
 */
@property (nonatomic, assign) BOOL transcode;
/**
 最大超时重试次数,默认值INT_MAX
 */
@property (nonatomic, assign) uint32_t maxRetryCount;
/**
 超时时间
 */
@property (nonatomic, assign) NSTimeInterval timeoutIntervalForRequest;
/**
 缓存文件夹位置
 */
@property (nonatomic, copy) NSString * recordDirectoryPath;
/**
 是否记录上传进度(断点续传),默认值YES
 */
@property (nonatomic, assign) BOOL recordUploadProgress;
/**
 分片大小,默认值1024 * 1024
*/
@property (nonatomic, assign) NSInteger uploadPartSize;
/**
 vod region,默认值"cn-shanghai"
 */
@property (nonatomic, copy) NSString *region;