Spring Boot 开发起步套件指南:Genc/spring-boot-boilerplate
本指南将引导您了解并使用 Genc/spring-boot-boilerplate,一个基于Spring Boot 3.3.1的快速开发起点项目。该项目整合了Spring Data JPA、Spring Validation、Spring Security配合JWT认证、PostgreSQL数据库、MapStruct、Lombok以及Swagger(OpenAPI)等技术。
1. 项目目录结构及介绍
项目遵循Spring Boot的标准目录结构,并包含以下关键部分:
-
src/main/java:存放所有Java源代码。
com.example.demo
(或按实际命名空间):包含主要的应用程序类、实体类、服务层、控制层等。config
:配置文件夹,包括安全性配置、数据库连接等配置类。
-
src/main/resources:资源文件夹。
application.yml
或.properties
:存放应用的配置信息。static
和public
:用于存放前端静态资源,尽管在纯后端项目中可能用得较少。templates
:如果使用Thymeleaf或其他模板引擎,则在此存放视图模板。SwaggerConfig.java
:配置Swagger接口文档相关的设置。
-
src/test:单元测试和集成测试代码放置处。
2. 项目的启动文件介绍
启动文件位于src/main/java
下的主应用程序包内,通常名为Application.java
或类似名称,例如DemoApplication.java
。它通过添加@SpringBootApplication
注解标记为入口点,示例如下:
package com.example.demo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args);
}
}
此文件是启动整个Spring Boot应用的核心,执行main
方法时会加载Spring容器并启动应用。
3. 项目的配置文件介绍
application.yml
配置文件位于src/main/resources
下,主要进行项目的基本配置。几个关键的自定义点包括:
- 数据库连接:您可以在这里配置PostgreSQL数据库的URL、用户名和密码。
- JWT配置:包括密钥、发行者、过期时间等,以确保安全令牌的有效性。
- Swagger配置:定制API文档的信息展示,如基本路径、描述等。
- Spring Security:可以定义哪些端点无需认证即可访问。
示例配置片段:
spring:
datasource:
url: jdbc:postgresql://localhost:5432/mydb
username: myuser
password: mypassword
security:
jwt:
secret-key: my-secret-key
token-validity-in-minutes: 1440
swagger:
api-version: 1.0.0
title: My API
description: A sample API for demonstration purposes.
按照以上说明,开发者能够轻松理解和配置这个Spring Boot项目,进而快速开始开发工作。记得在运行应用之前检查数据库是否已准备好,并且通过Maven命令mvn clean install
构建项目,之后使用java -jar <target目录中的jar文件名>
来启动应用。