Starward 项目使用教程

1. 项目的目录结构及介绍

Starward/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   ├── com/
│   │   │   │   ├── example/
│   │   │   │   │   ├── App.java
│   │   │   │   │   ├── Config.java
│   │   │   │   │   ├── Utils.java
│   │   │   │   │   └── ...
│   │   │   │   └── ...
│   │   │   └── ...
│   │   └── resources/
│   │       ├── application.properties
│   │       ├── logback.xml
│   │       └── ...
│   └── test/
│       ├── java/
│       │   ├── com/
│       │   │   ├── example/
│       │   │   │   ├── AppTest.java
│       │   │   │   └── ...
│       │   │   └── ...
│       │   └── ...
│       └── resources/
│           └── ...
├── .gitignore
├── README.md
├── LICENSE
└── pom.xml

目录结构说明

• src/main/java/: 包含项目的所有Java源代码。
  • com/example/: 主要业务逻辑代码。
    • App.java: 项目的主启动类。
    • Config.java: 配置类。
    • Utils.java: 工具类。
• src/main/resources/: 包含项目的配置文件和其他资源文件。
  • application.properties: 主要的配置文件。
  • logback.xml: 日志配置文件。
• src/test/java/: 包含项目的测试代码。
  • com/example/: 测试类。
    • AppTest.java: 主启动类的测试类。
• src/test/resources/: 包含测试所需的资源文件。
• .gitignore: Git忽略文件配置。
• README.md: 项目说明文档。
• LICENSE: 项目许可证。
• pom.xml: Maven项目配置文件。

2. 项目的启动文件介绍

App.java

package com.example;

public class App {
    public static void main(String[] args) {
        System.out.println("Starward 项目启动...");
        // 初始化配置
        Config config = new Config();
        config.load();
        // 启动逻辑
        Utils.start();
    }
}

启动文件说明

• App.java 是项目的主启动类，包含 main 方法，负责初始化和启动项目。
• 在 main 方法中，首先初始化配置类 Config，然后调用工具类 Utils 的 start 方法启动项目。

3. 项目的配置文件介绍

application.properties

# 数据库配置
spring.datasource.url=jdbc:mysql://localhost:3306/starward
spring.datasource.username=root
spring.datasource.password=123456

# 日志配置
logging.level.root=INFO
logging.file.name=logs/starward.log

配置文件说明

• application.properties 是项目的主要配置文件，包含数据库连接信息和日志配置。
  • spring.datasource.url: 数据库连接URL。
  • spring.datasource.username: 数据库用户名。
  • spring.datasource.password: 数据库密码。
  • logging.level.root: 日志级别。
  • logging.file.name: 日志文件路径。

logback.xml

<configuration>
    <appender name="FILE" class="ch.qos.logback.core.FileAppender">
        <file>${logging.file.name}</file>
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss} %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>

    <root level="${logging.level.root}">
        <appender-ref ref="FILE" />