对象存储OSS之创建OSS微服务

傷城~ 2021-06-10 20:40 519阅读 0赞

之前已经学习了OSS的一些基本API，接下来可以在微服务中使用它了。

## 创建OSS微服务 ##

1、创建SpringBoot微服务wunian-edu-oss，然后在pom.xml中导入相关依赖。

<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
        </dependency>
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
        </dependency>
        
        <dependency>
            <groupId>com.aliyun.oss</groupId>
            <artifactId>aliyun-sdk-oss</artifactId>
        </dependency>
        
        <dependency>
            <groupId>joda-time</groupId>
            <artifactId>joda-time</artifactId>
            <version>2.10.1</version>
        </dependency>
        
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-devtools</artifactId>
        </dependency>
    </dependencies>

2、在application.properties中添加相关配置。

# server
    server.port=8130
    # 服务名
    spring.application.name=wunian-aliyunoss
    # 环境
    spring.profiles.active=dev
    # 配置OSS的参数，自定义参数进行加载，以下参数从阿里云OSS账户中获取
    aliyun.oss.file.endpoint=oss-cn-beijing.aliyuncs.com
    aliyun.oss.file.accessKeyId=LTAI4FfEx3TmDfjemSd2Y7Q2
    aliyun.oss.file.accessKeySecret=zopf47hTj40JsFb8PTxoGHKEMRaAvi
    # 可以在控制台创建，也可以在代码中创建
    aliyun.oss.file.bucketName=wunian-edu
    aliyun.oss.file.filehost=avatar

3、在日志配置文件logback-spring.xml中配置日志相关参数。

<?xml version="1.0" encoding="UTF-8"?>
    
    <configuration  scan="true" scanPeriod="10 seconds">
        
        
        
        
        <contextName>logback</contextName>
        
        
        <property name="log.path" value="D:/Files/Project/代码/wunian_edu_api/log/oss/" />
        
        
        
        
        
        
        
        <property name="CONSOLE_LOG_PATTERN"
                  value="%yellow(%date{yyyy-MM-dd HH:mm:ss}) |%highlight(%-5level) |%blue(%thread) |%blue(%file:%line) |%green(%logger) |%cyan(%msg%n)"/>
        
        <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
            
            
            <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
                <level>INFO</level>
            </filter>
            <encoder>
                <Pattern>${CONSOLE_LOG_PATTERN}</Pattern>
                
                <charset>UTF-8</charset>
            </encoder>
        </appender>
        
        
        <appender name="INFO_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            
            <file>${log.path}/log_info.log</file>
            
            <encoder>
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
                <charset>UTF-8</charset>
            </encoder>
            
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                
                <fileNamePattern>${log.path}/info/log-info-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>100MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                
                <maxHistory>15</maxHistory>
            </rollingPolicy>
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>INFO</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
        
        <appender name="WARN_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            
            <file>${log.path}/log_warn.log</file>
            
            <encoder>
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
                <charset>UTF-8</charset> 
            </encoder>
            
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>${log.path}/warn/log-warn-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>100MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                
                <maxHistory>15</maxHistory>
            </rollingPolicy>
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>warn</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
        
        <appender name="ERROR_FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
            
            <file>${log.path}/log_error.log</file>
            
            <encoder>
                <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
                <charset>UTF-8</charset> 
            </encoder>
            
            <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
                <fileNamePattern>${log.path}/error/log-error-%d{yyyy-MM-dd}.%i.log</fileNamePattern>
                <timeBasedFileNamingAndTriggeringPolicy class="ch.qos.logback.core.rolling.SizeAndTimeBasedFNATP">
                    <maxFileSize>100MB</maxFileSize>
                </timeBasedFileNamingAndTriggeringPolicy>
                
                <maxHistory>15</maxHistory>
            </rollingPolicy>
            
            <filter class="ch.qos.logback.classic.filter.LevelFilter">
                <level>ERROR</level>
                <onMatch>ACCEPT</onMatch>
                <onMismatch>DENY</onMismatch>
            </filter>
        </appender>
        
        
        
        
        <springProfile name="dev">
            
            <logger name="com.coding" level="INFO" />
            
            <root level="INFO">
                <appender-ref ref="CONSOLE" />
                <appender-ref ref="INFO_FILE" />
                <appender-ref ref="WARN_FILE" />
                <appender-ref ref="ERROR_FILE" />
            </root>
        </springProfile>
        
        
        <springProfile name="pro">
            
            <logger name="com.coding" level="WARN" />
            <root level="INFO">
                <appender-ref ref="ERROR_FILE" />
                <appender-ref ref="WARN_FILE" />
            </root>
        </springProfile>
    </configuration>

4、创建读取配置文件的工具类，实现InitializingBean接口。重写afterPropertiesSet()方法，该方法将在所有属性配置被初始化的时候调用。

@Component  //读取配置文件
    public class ConstantProperties implements InitializingBean {
        
        @Value("${aliyun.oss.file.endpoint}")
        private String endpoint;
    
        @Value("${aliyun.oss.file.accessKeyId}")
        private String accessKeyId;
    
        @Value("${aliyun.oss.file.accessKeySecret}")
        private String accessKeySecret;
    
        @Value("${aliyun.oss.file.bucketName}")
        private String bucketName;
    
        @Value("${aliyun.oss.file.filehost}")
        private String fileHost;
        //方便未来使用
        public static String END_POINT;
        public static String ACCESS_KEY_ID;
        public static String ACCESS_KEY_SECRET;
        public static String BUCKET_NAME;
        public static String FILE_HOST;
        
      	@Override
        public void afterPropertiesSet() throws Exception {
            END_POINT = endpoint;
            ACCESS_KEY_ID = accessKeyId;
            ACCESS_KEY_SECRET = accessKeySecret;
            BUCKET_NAME = bucketName;
            FILE_HOST = fileHost;
        }
    }

5、编写文件上传服务接口和实现类，实现文件上传阿里云服务器方法。  
FileService.java

public interface FileService{
      String upload(MultipartFile file);//文件上传到阿里云服务器
    }

FileServiceImpl.java

@Service
    public class FileServiceImpl implements FileService{
        
        @Override
        public String upload(MultipartFile file){
            // 基本配置，可以变化的，通过配置文件变化，不需要改代码（降低耦合性）
            String endpoint = ConstantProperties.END_POINT;
            String accessKeyId = ConstantProperties.ACCESS_KEY_ID;
            String accessKeySecret = ConstantProperties.ACCESS_KEY_SECRET;
            String bucketName = ConstantProperties.BUCKET_NAME;
            String fileHost = ConstantProperties.FILE_HOST;
            String uploadUrl = null;
            
            try {
                // 判断oss 是否存在
                OSS ossClient = new OSSClientBuilder().build(endpoint, accessKeyId, accessKeySecret);
                // 不存在就创建
                if (!ossClient.doesBucketExist(bucketName)){
                    ossClient.createBucket(bucketName);
                    ossClient.setBucketAcl(bucketName,CannedAccessControlList.PublicRead);
                }
                // 获取文件上传流
                InputStream inputStream = file.getInputStream();
                // 保存到oss路径（重写文件名称，文件分类：上传文件的核心思想）
                String filePath = new DateTime().toString("yyyy/MM/dd");
                // 文件名 uuid
                String original = file.getOriginalFilename(); // a.jpg
                String fileName = UUID.randomUUID().toString();
                String fileType = original.substring(original.lastIndexOf("."));
                String newName = fileName + fileType; // 我们处理完毕的思想
                // 构建完成路径
                String fileUrl = fileHost + "/" + filePath + "/" + newName;
                // 文件上传到阿里云
                ossClient.putObject(bucketName,fileUrl,inputStream);
                // 关闭连接
                ossClient.shutdown();
                // 获取上传后的文件地址
                uploadUrl = "https://" + bucketName + "." + endpoint + "/" + fileUrl;
            } catch (IOException e) {
                e.printStackTrace();
            }
            return uploadUrl;
        }
    }

6、编写文件上传控制类，添加文件上传请求方法。

@Api(description = "阿里云文件管理")
    @RestController
    @CrossOrigin // 跨域
    @RequestMapping("/admin/oss/file")
    public class FileController {
    
        @Autowired
        private FileService fileService;
    
        @ApiOperation(value = "文件上传")
        @PostMapping("upload")
        public R upload(
                @ApiParam(name = "file",value = "文件",required = true)
                @RequestParam MultipartFile file){
            String uploadUrl = fileService.upload(file);
            return R.ok().message("文件上传成功").data("url",uploadUrl);
        }
    }

7、编写Swagger配置类，添加Swagger配置方法。

@Configuration
    @EnableSwagger2
    public class Swagger2Config {
    
        @Bean
        public Docket webApiConfig(){
            return new Docket(DocumentationType.SWAGGER_2)
                    .apiInfo(webApiInfo())
                    .select()
                    .paths(Predicates.not(PathSelectors.regex("/error.*")))
                    .build();
        }
    
        private ApiInfo webApiInfo(){
            return new ApiInfoBuilder()
                    .title("文件上传微服务")
                    .description("本文档描述了文件上传微服务接口定义")
                    .version("1.0")
                    .contact(new Contact("wunian", "http://wunianedu.com", "XXXXXX@qq.com"))
                    .build();
        }
    }

8、启动微服务，访问http://localhost:8130/swagger-ui.html 查看Swagger文档，可以直接在Swagger文档页面对接口进行测试。  
![swagger-ui.html][]

[swagger-ui.html]: /images/20210607/7b2fc5b890004d88a1de9bed38f8e6a3.png