Spring Boot 2 API 项目教程

Spring Boot 2 API 项目教程

1. 项目目录结构及介绍

spring-boot-2-api
├── edu-common -- 工具类及通用代码
├── edu-db -- 数据库操作代码(可使用MybatisCodeHelperPro)
├── edu-security -- SpringSecurity封装的公用模块
├── edu-api-portal -- 前台系统接口
└── edu-api-admin -- 后台系统接口

目录结构说明

• edu-common: 包含项目的工具类和通用代码，如注解、配置、数据封装等。
• edu-db: 包含数据库操作代码，使用 MyBatis 进行 ORM 映射。
• edu-security: 包含 Spring Security 封装的公用模块，用于认证和授权。
• edu-api-portal: 前台系统接口，提供前端系统所需的 API。
• edu-api-admin: 后台系统接口，提供后台管理系统所需的 API。

2. 项目启动文件介绍

项目的启动文件位于 edu-api-portal 和 edu-api-admin 模块中，分别是 edu-api-portal/src/main/java/com/example/Application.java 和 edu-api-admin/src/main/java/com/example/Application.java。

启动文件示例

package com.example;

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

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

启动文件说明

• @SpringBootApplication: 这是一个组合注解，包含了 @Configuration、@EnableAutoConfiguration 和 @ComponentScan，用于启动 Spring Boot 应用。
• SpringApplication.run(Application.class, args): 启动 Spring Boot 应用。

3. 项目配置文件介绍

项目的配置文件主要位于 edu-api-portal 和 edu-api-admin 模块的 src/main/resources 目录下，包括 application.yml、application-dev.yml 和 application-pro.yml。

配置文件示例

# application.yml
spring:
  datasource:
    url: jdbc:mysql://localhost:3306/your_database
    username: your_username
    password: your_password
  redis:
    host: localhost
    port: 6379

配置文件说明

• application.yml: 主配置文件，包含数据库连接、Redis 配置等。
• application-dev.yml: 开发环境配置文件，可以覆盖主配置文件中的某些配置。
• application-pro.yml: 生产环境配置文件，可以覆盖主配置文件中的某些配置。

通过这些配置文件，可以灵活地配置不同环境下的数据库连接、缓存设置等。