# java17-scaffold

**Repository Path**: bestyys/java17-scaffold

## Basic Information

- **Project Name**: java17-scaffold
- **Description**: Java17-scaffold：基于最新Java 17版本的项目脚手架，为开发者提供快速启动应用的模板和最佳实践，支持现代化开发需求。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-09-06
- **Last Updated**: 2025-09-06

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Spring Boot 脚手架项目

这是一个基于 Java 17 和 Spring Boot 3.5.5 的脚手架项目，可以帮助你快速创建 Spring Boot 应用。

## 特性

- 预配置 Spring Boot Web、AOP、JPA 等常用模块
- 集成 Lombok 简化开发
- 提供完整的项目结构示例
- 内置日志配置(logback-spring.xml)
- AOP 切面示例
- 数据库访问层示例(JPA)
- RESTful API 示例

## 快速开始

### 使用脚手架创建项目

1. 双击运行 [init-project.bat](file://C:\workspace_idea\java17-scaffold\init-project.bat) 脚本
2. 按提示输入项目名称和选择配置选项:
   - 项目名称
   - 数据库类型(H2/MySQL/无)
   - 是否使用 Redis
   - 是否启用 Spring Security
   - 是否配置 Maven 国内镜像源
3. 脚本会自动创建并配置新项目
4. 进入新创建的项目目录并根据需要修改配置

### 手动配置 Maven 国内源

如果你没有通过脚手架脚本自动配置 Maven 国内源，可以手动配置:

1. 将 [settings.xml](file://C:\workspace_idea\java17-scaffold\settings.xml) 文件复制到 `~/.m2/` 目录下
2. 如果 `~/.m2/` 目录不存在，请先创建该目录

配置好后，Maven 将使用阿里云镜像源下载依赖，大大提高下载速度。

### 运行项目

```bash
# 进入项目目录
cd your-project-name

# 运行项目
mvn spring-boot:run
```

访问 http://localhost:8080/hello 查看示例接口

## 项目结构

```
├── src
│   ├── main
│   │   ├── java
│   │   │   └── com/example/your-project
│   │   │       ├── Java17ScaffoldApplication.java  # 启动类
│   │   │       ├── controller                       # 控制器层
│   │   │       ├── service                          # 服务层
│   │   │       ├── entity                           # 实体类
│   │   │       ├── repository                       # 数据访问层
│   │   │       └── aop                              # 切面逻辑
│   │   └── resources
│   │       ├── application.properties               # 应用配置
│   │       └── logback-spring.xml                  # 日志配置
│   └── test                                        # 测试代码
├── pom.xml                                         # Maven 配置
└── settings.xml                                    # Maven 镜像源配置
```

## 技术栈

- Java 17
- Spring Boot 3.5.5
- Maven 3.5+
- Spring Web
- Spring AOP
- Spring Data JPA
- H2 Database (默认)
- Lombok

## 依赖管理

项目已配置阿里云 Maven 镜像源，可显著提高依赖下载速度。

## 配置说明

### 数据库配置

项目默认使用 H2 内存数据库，方便开发测试。如需切换为 MySQL，请修改 [application.properties](file://C:\workspace_idea\java17-scaffold\src\main\resources\application.properties) 中的数据库配置。

### 日志配置

日志配置文件为 [logback-spring.xml](file://C:\workspace_idea\java17-scaffold\src\main\resources\logback-spring.xml)，支持控制台和文件输出，以及异步日志记录。

## 许可证

MIT