iOS OSS上传文件问题

最近接入OSS SDK做资源上传到OSS，期间遇到的一些问题，做一下记录

1. OSS SDK接入

选择接入OSS SDK而不是直接拼form表单去上传文件，主要是SDK提供了一系列的功能，实现起来存在一定成本；SDK内部提供了并发上传、大文件分批上传、断点续传、上传下载进度管理等
接入SDK直接使用pod的方式

pod 'AliyunOSSiOS'

一般文件上传，使用OSSPutObjectRequest
大文件分批上传，使用OSSMultipartUploadRequest

2. 上传和下载文件

官方的demo也有示例，可以参照着做一些修改和完善

由于OSS文件存储是收费的，所以我们一般在管理OSS的bucket的时候需要设置权限（公共读、公共读写、私有），官方建议是设置成私有权限，避免被人恶意写入或者私密的文件被获取

公共读：未授权用户只有读权限，写入操作需要授权
公共读写：所有的用户都可以读写
私有：只有授权的用户才有读写权限

需要鉴权的流程：获取授权（服务端下发一个临时用户的鉴权信息）-- 根据鉴权信息进行签名然后发起请求 -- OSS服务校验 -- 返回结果

公共读写权限的则不需要鉴权流程

配置client

根据服务端下发的配置信息，初始化OSSClient，需要注意的是设置Client的endpoint的时候用endpointExceptBucket（如果服务端返回的endpoint中包含了bucket信息，那么就截取掉）

- (void)configClient {
    OSSStsTokenCredentialProvider *provider = [[OSSStsTokenCredentialProvider alloc] initWithAccessKeyId:self.configuration.accessKeyId
                                                                                             secretKeyId:self.configuration.accessKeySecret
                                                                                           securityToken:self.configuration.securityToken];
    _defaultClient = [[OSSClient alloc] initWithEndpoint:self.configuration.endpointExceptBucket credentialProvider:provider];
}

- (NSString *)endpointExceptBucket {
    NSString *needReplaceString = [NSString stringWithFormat:@"%@.", _ossBucket];
    _endpointExceptBucket = [[_endpoint stringByReplacingOccurrencesOfString:needReplaceString withString:@""] oss_trim];
    
    return _endpointExceptBucket;
}

上传文件

- (void)asyncPutFile:(NSString *)objectKey localFilePath:(NSString *)filePath progress:(OSSProgressBlock _Nullable)uploadProgress success:(void (^ _Nullable)(CassOSSUploadResult * _Nonnull))success failure:(void (^ _Nullable)(NSError * _Nonnull, NSString * _Nonnull))failure {
    if (![objectKey oss_isNotEmpty]) {
        NSError *error = [NSError errorWithDomain:NSInvalidArgumentException code:0 userInfo:@{NSLocalizedDescriptionKey: @"objectKey should not be nil"}];
        failure(error, filePath);
        return;
    }
    
    _normalUploadRequest = [OSSPutObjectRequest new];
    _normalUploadRequest.bucketName = self.configuration.ossBucket;
    _normalUploadRequest.objectKey = objectKey;
    _normalUploadRequest.uploadingFileURL = [NSURL fileURLWithPath:filePath];
    _normalUploadRequest.isAuthenticationRequired = YES;
    _normalUploadRequest.uploadProgress = ^(int64_t bytesSent, int64_t totalByteSent, int64_t totalBytesExpectedToSend) {
        dispatch_async(dispatch_get_main_queue(), ^{
            CGFloat progress = 1.f * totalByteSent / totalBytesExpectedToSend;
            if (uploadProgress) {
                uploadProgress(progress);
            }
        });
    };
    dispatch_async(dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0), ^{
        OSSTask * task = [self.defaultClient putObject:self.normalUploadRequest];
        [task continueWithBlock:^id(OSSTask *task) {
            dispatch_async(dispatch_get_main_queue(), ^{
                if (task.error) {
                    if (failure) {
                        failure(task.error, filePath);
                    }
                } else {
                    if (success) {
                        NSString *ossFileURL = [NSString stringWithFormat:@"%@/%@", self.configuration.endpoint, objectKey];
                        CassOSSUploadResult *result = [CassOSSUploadResult new];
                        result.fileURL = ossFileURL;
                        result.fileLocalPath = filePath;
                        success(result);
                    }
                }
            });
            
            return nil;
        }];
    });
}

objectKey一般是一个OSS的文件路径+上传的文件名；⚠️ Object的命名规范：使用UTF-8编码，长度必须在1-1023字节之间，不能以“/”或者“\”字符开头，中间的路径也不能多"/"分隔符例如： image/user//xxx/xxx.png，中间多了分隔符
bucketName 只能包括小写字母、数字和短横线（-），必须以小写字母或者数字开头，长度必须在3-63字节之间。
isAuthenticationRequired这个属性需要重点关注，默认是YES是需要做校验的，如果设置了私有读权限那么这个值就设置为YES，否则会校验失败；下载的时候这个值如果不是私有写权限，这个设置为NO，否则会校验失败。

下载文件

方式跟上传文件类似，使用OSSGetObjectRequest

遇到的问题

AccessDenied

Error Domain=com.aliyun.oss.serverError Code=-403 "(null)" UserInfo={__name=Error, HostId=xxx.oss-cn-shenzhen.aliyuncs.com, Message=You have no right to access this object because of bucket acl., Code=AccessDenied, RequestId=5D5217E3AA5E736DC2B7DB02}

这种是服务端校验权限失败导致的，子用户/临时用户没有访问Object的权限（如putObject getObject、appendObject deleteObject、postObject）等

解决方法：

检查用户的权限是否正确，权限问题排查
检查bucket设置的权限（公共读、公共读写、私有），根据权限来设置调用接口时isAuthenticationRequired属性的值，需要权限的就设置为YES，不需要的设置为NO

在开发的过程中，bucket是设置的公共读权限，调用的时候虽然设置了client的credentialProvider，但是由于设置isAuthenticationRequired时候设置的是NO，导致报上述错误，这个就是由于没有阅读sdk的源码，在创建task的时候会根据设置的值去设置interceptors，源码如下：

- (OSSTask *)invokeRequest:(OSSNetworkingRequestDelegate *)request requireAuthentication:(BOOL)requireAuthentication {
    /* if content-type haven't been set, we set one */
    if (!request.allNeededMessage.contentType.oss_isNotEmpty
        && ([request.allNeededMessage.httpMethod isEqualToString:@"POST"] || [request.allNeededMessage.httpMethod isEqualToString:@"PUT"])) {

        request.allNeededMessage.contentType = [OSSUtil detemineMimeTypeForFilePath:request.uploadingFileURL.path               uploadName:request.allNeededMessage.objectKey];
    }

    // Checks if the endpoint is in the excluded CName list.
    [self.clientConfiguration.cnameExcludeList enumerateObjectsUsingBlock:^(NSString *exclude, NSUInteger idx, BOOL * _Nonnull stop) {
        if ([self.endpoint hasSuffix:exclude]) {
            request.allNeededMessage.isHostInCnameExcludeList = YES;
            *stop = YES;
        }
    }];

    id uaSetting = [[OSSUASettingInterceptor alloc] initWithClientConfiguration:self.clientConfiguration];
    [request.interceptors addObject:uaSetting];

    /* check if the authentication is required */
    if (requireAuthentication) {
        id signer = [[OSSSignerInterceptor alloc] initWithCredentialProvider:self.credentialProvider];
        [request.interceptors addObject:signer];
    }

    request.isHttpdnsEnable = self.clientConfiguration.isHttpdnsEnable;

    return [_networking sendRequest:request];
}

iOS OSS上传文件问题