一、 前言在一个微服务项目里我们的 OSS 云存储服务常常需要配置诸如阿里云、腾讯云、minio 等多个云存储厂商的业务代码而且后续无法确保是否会增添新的云存储厂商。此时倘若我们要修改具体使用的云存储厂商就会致使 controller 层和 service 层发生变动这并不符合低耦合的理念。在这种情况下我们完全可以采用适配器模式来开展项目开发二、适配器模式改造MinioUtils和AliyunUtils被适配者类作为源接口执行原子性操作的具体逻辑各不相同想要把多个OSS共用一个相同的接口返回就需要使用到适配器模式。被适配器类Component publicclassMinioUtil{ Resource private MinioClient minioClient; /** * 创建Bucket桶(文件夹目录) */ publicvoidcreateBucket(String bucket)throws Exception { boolean exists minioClient.bucketExists(BucketExistsArgs.builder().bucket(bucket).build()); if(!exists) { //不存在创建 minioClient.makeBucket(MakeBucketArgs.builder().bucket(bucket).build()); } } /** * 上传文件 * inputStream处理文件的输入流 * bucket桶名称 * objectName桶中的对象名称也就是上传后的文件在存储桶中的存储路径和文件名。 * stream(inputStream处理文件的输入流-1指定缓冲区大小的参数[-1为默认大小] 5242889L指定文件内容长度的上限) */ publicvoiduploadFile(InputStream inputStream, String bucket, String objectName)throws Exception { minioClient.putObject(PutObjectArgs.builder().bucket(bucket).object(objectName) .stream(inputStream, -1, 5242889L).build()); } }这是目标接口 (目标抽象类即客户需要的方法)我们想要的不同OSS都可通过该接口进行操作/** * 为了方便切换任何一个oss我们将公共方法抽取为接口由某个oss的实现类去编写具体逻辑 */ publicinterfaceStorageAdapter{ /** * 创建bucket * param bucket */ voidcreateBucket(String bucket); /** * 上传文件 * param multipartFile * param bucket * param objectName */ voiduploadFile(MultipartFile multipartFile, String bucket, String objectName); /** * 获取文件在oss中的url * param bucket * param objectName * return */ String getUrl(String bucket, String objectName); }Minio适配器类通过继承或者组合方式将被适配者类(minioUtils)的接口与目标抽象类的接口转换起来使得客户端可以按照目标抽象类的接口进行操作。/** * Minio相关操作的具体逻辑 */ Log4j2 publicclassMinioStorageAdapterimplementsStorageAdapter{ Resource private MinioUtil minioUtil; Value(${minio.url}) private String url; Override SneakyThrows//Lombok中的注解 会在编译期补上异常处理 publicvoidcreateBucket(String bucket){ minioUtil.createBucket(bucket); } /** * 上传文件 * param multipartFile * param bucket * param objectName 为空文件路径为根目录不为空文件路径为objectName目录下 */ Override SneakyThrows publicvoiduploadFile(MultipartFile multipartFile, String bucket, String objectName){ minioUtil.createBucket(bucket); if(objectName ! null) { minioUtil.uploadFile(multipartFile.getInputStream(), bucket, objectName / multipartFile.getOriginalFilename()); } else { minioUtil.uploadFile(multipartFile.getInputStream(), bucket, multipartFile.getOriginalFilename()); } } /** * 获取文件在oss中的url * param bucket * param objectName * return */ Override public String getUrl(String bucket, String objectName){ return url / bucket / objectName; } }Aliyun适配器类/** * 阿里云oss 具体实现逻辑 */ publicclassAliStorageAdapterimplementsStorageAdapter{ Override publicvoidcreateBucket(String bucket){ System.out.println(aliyun); } Override publicvoiduploadFile(MultipartFile multipartFile, String bucket, String objectName){ } Override public String getUrl(String bucket, String objectName){ returnaliyun; } }三、定义StorageConfig类来获取指定的文件适配器通过Nacos的动态配置读取来得到当前的storageType此时如果想再加入一个新的OSS对象(得到xxUtils jar包等我们无法进行修改)只需新增一个xxadapter适配器类且在Bean注解的方法中加一个else即可。注意这里直接使用new的方式创建实现类(实现类也不需要使用Service注解)而不是先把所有的实现类通过注解定义出来再直接返回对象这样如果新增一个OSS的话不光要加else还需再把实现类通过直接定义出来。Configuration publicclassStorageConfig{ Value(${storage.service.type}) private String storageType; Bean public StorageAdapter storageAdapter(){ if(minio.equals(storageType)) { returnnew MinioStorageAdapter(); } elseif(aliyun.equals(storageType)) { returnnew AliStorageAdapter(); } else { thrownew IllegalArgumentException(为找到对应的文件存储处理器); } } }四、新增FileService防腐提高可维护性/** * FileService防腐层 使用fileService(相当于domain防腐层)与adapter(相当于service层只做原子性操作)进行交互、Utils相当于dao层 */ Component publicclassFileService{ /** * 通过构造函数注入 */ privatefinal StorageAdapter storageAdapter; publicFileService(StorageAdapter storageAdapter){ this.storageAdapter storageAdapter; } /** * 创建bucket * param bucket */ publicvoidcreateBucket(String bucket){ storageAdapter.createBucket(bucket); } /** * 上传图片、返回图片在minio的地址 * param multipartFile * param bucket * param objectName */ public String uploadFile(MultipartFile multipartFile, String bucket, String objectName){ storageAdapter.uploadFile(multipartFile, bucket, objectName); objectName (StringUtils.isEmpty(objectName) ? : objectName /) multipartFile.getOriginalFilename(); return storageAdapter.getUrl(bucket, objectName); } }五、Controller层Controller层通过注入FileService来进行操作RestController Log4j2 publicclassFileController{ Resource//根据名称注入 private FileService fileService; /** * 上传文件, 返回文件在oss中的地址 * param uploadFile:文件, getOriginalFilename获取原始文件名 * param bucket桶名称 * param objectName上传后的文件在存储桶中的存储路径(存储目录) * return String: 返回文件在minio的链接地址 */ PostMapping(/upload) public ResultString upload(MultipartFile uploadFile, String bucket, String objectName)throws Exception { try { Preconditions.checkArgument(!ObjectUtils.isEmpty(uploadFile), 文件不能为空); Preconditions.checkArgument(!StringUtils.isEmpty(bucket), bucket桶名称不能为空); if(log.isInfoEnabled()) { log.info(FileController.upload.uploadFile:{}, bucket:{}, objectName:{}, uploadFile.getOriginalFilename(), bucket, objectName); } String url fileService.uploadFile(uploadFile, bucket, objectName); return Result.ok(url); } catch (Exception e) { log.info(FileController.upload.error{}, e.getMessage(), e); return Result.fail(上传文件失败); } } }六、Nacos搭建6.1 Nacos部署服务器需开启8848、9848端口docker search nacos docker pull nacos/nacos-server # 镜像拉完之后启动脚本 docker run -d \ --name nacos \ --privileged \ --cgroupns host \ --env JVM_XMX256m \ --env MODEstandalone \ --env JVM_XMS256m \ -p 8848:8848/tcp \ -p 9848:9848/tcp \ --restartalways \ -w /home/nacos \ nacos/nacos-server--privileged赋予容器扩展的特权--cgroupns host让容器使用宿主机的 cgroup 命名空间在资源限制方面容器会遵循宿主机规则--env设置Nacos服务使用的jvm参数JVM_XMX最大堆内存为 256mJVM_XMS初始堆内存为 256 m--env MODEstandalonenacos运行模式为单机模式-w /home/nacos指定容器内的工作目录为 “/home/nacos”容器内执行的命令如果涉及到相对路径的操作就会以这个目录作为当前工作目录的基准。8848Nacos服务端端口9848客户端gRPC请求服务端端口6.2 引入nacos客户依赖除了引入nacos依赖还要引入log4j2依赖来输出nacos日志信息SpringCloudAlibaba 版本为2.2.6.RELEASE时springboot版本要为2.3.8.RELEASE!--nacos依赖(配合日志打印nacos信息)-- dependency groupIdcom.alibaba.cloud/groupId artifactIdspring-cloud-starter-alibaba-nacos-config/artifactId version2.2.6.RELEASE/version /dependency dependency groupIdorg.springframework.boot/groupId artifactIdspring-boot-starter-log4j2/artifactId version2.4.2/version /dependency6.3 编写配置文件把nacos相关配置写入bootstrap.yml文件中项目启动后会优先读取。spring: application: name:jc-club-oss#微服务名称 profiles: active:dev#指定环境为开发环境 cloud: nacos: server-addr:117.72.118.73:8848 config: file-extension:yaml#文件后缀名6.4 新增配置管理dataId:jc-club-oss-dev.yaml服务名称开发环境.yaml配置内容:这时spring会根据bootstrap.yml文件中的${spring.application.name}-${spring.profiles.active}.${spring.cloud.nacos.config.file-extension}作为文件id来读取配置6.5 添加RefreshScope注解开启热更新在Value注入的变量所在类上添加注解RefreshScop当配置文件内容发生变化后会重新读取当文件更新后Bean已加入到了IOC容器即使storageType属性值变了Bean也无法重新加载。所以在Bean方法上也要加入RefreshScop注解当文件更新后带有此注解的Bean能够自动重新初始化Configuration RefreshScope publicclassStorageConfig{ Value(${storage.service.type}) private String storageType; Bean RefreshScope public StorageAdapter storageAdapter(){ if(minio.equals(storageType)) { returnnew MinioStorageAdapter(); } elseif(aliyun.equals(storageType)) { returnnew AliStorageAdapter(); } else { thrownew IllegalArgumentException(为找到对应的文件存储处理器); } } }6.6 测试1.type为阿里云结果为成功返回aliyun2.修改属性为minio结果为图片成功上传。在配置文件更新时nacos也会打印出对应的日志提示2024-12-03 17:05:50.719 INFO 35932 --- [.72.118.73_8848] o.s.c.e.e.RefreshEventListener : Refresh keys changed: [storage.service.type]看完等于学会点个赞吧