oss-spring-boot-starter 项目使用教程

oss-spring-boot-starter 项目使用教程

oss-spring-boot-starter 兼容S3协议的通用文件存储工具类 项目地址: https://gitcode.com/gh_mirrors/os/oss-spring-boot-starter

1. 项目目录结构及介绍

oss-spring-boot-starter/
├── github/workflows/
│   └── ...
├── mvn/wrapper/
│   └── ...
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/
│   │   │       └── pig4cloud/
│   │   │           └── plugin/
│   │   │               └── oss/
│   │   │                   └── ...
│   │   └── resources/
│   │       └── ...
│   └── test/
│       └── ...
├── .editorconfig
├── .gitignore
├── LICENSE
├── README.md
├── mvnw
├── mvnw.cmd
└── pom.xml

目录结构说明

• github/workflows/: 存放GitHub Actions的工作流配置文件。
• mvn/wrapper/: Maven Wrapper的相关文件，用于确保项目使用特定版本的Maven。
• src/main/java/: 项目的主要Java源代码。
• src/main/resources/: 项目的资源文件，如配置文件等。
• src/test/: 项目的测试代码。
• .editorconfig: 编辑器配置文件，用于统一代码风格。
• .gitignore: Git忽略文件配置。
• LICENSE: 项目许可证文件。
• README.md: 项目说明文档。
• mvnw: Maven Wrapper的启动脚本。
• mvnw.cmd: Maven Wrapper的Windows启动脚本。
• pom.xml: Maven项目的配置文件。

2. 项目的启动文件介绍

项目的启动文件通常位于src/main/java/目录下，具体路径为com/pig4cloud/plugin/oss/OssApplication.java。该文件是Spring Boot应用程序的入口点。

package com.pig4cloud.plugin.oss;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class OssApplication {
    public static void main(String[] args) {
        SpringApplication.run(OssApplication.class, args);
    }
}

启动文件说明

• @SpringBootApplication: 这是一个组合注解，包含了@Configuration、@EnableAutoConfiguration和@ComponentScan，用于自动配置Spring Boot应用程序。
• SpringApplication.run: 启动Spring Boot应用程序。

3. 项目的配置文件介绍

项目的配置文件通常位于src/main/resources/目录下，常见的配置文件包括application.properties或application.yml。

application.yml 示例

oss:
  endpoint: http://minio.pig4cloud.com
  access-key: lengleng
  secret-key: lengleng

配置文件说明

• oss.endpoint: 文件存储服务的端点URL。
• oss.access-key: 访问密钥。
• oss.secret-key: 密钥。

这些配置项用于连接兼容S3协议的云存储服务，如MINIO、阿里云、华为云、腾讯云、京东云等。

---

通过以上步骤，您可以成功启动并配置oss-spring-boot-starter项目，开始使用兼容S3协议的通用文件存储工具类。

oss-spring-boot-starter 兼容S3协议的通用文件存储工具类 项目地址: https://gitcode.com/gh_mirrors/os/oss-spring-boot-starter