MoneyNote API 项目教程

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

MoneyNote API 项目的目录结构如下：

moneynote-api/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/
│   │   │       └── moneynote/
│   │   │           └── api/
│   │   │               ├── controller/
│   │   │               ├── service/
│   │   │               ├── repository/
│   │   │               ├── model/
│   │   │               └── MoneynoteApiApplication.java
│   │   └── resources/
│   │       ├── application.properties
│   │       └── static/
│   └── test/
│       └── java/
│           └── com/
│               └── moneynote/
│                   └── api/
│                       └── MoneynoteApiApplicationTests.java
├── Dockerfile
├── README.md
└── pom.xml

目录结构介绍

• src/main/java/com/moneynote/api/: 包含项目的所有 Java 源代码。
  • controller/: 存放控制器类，处理 HTTP 请求。
  • service/: 存放服务类，处理业务逻辑。
  • repository/: 存放数据访问类，处理数据库操作。
  • model/: 存放数据模型类，定义数据结构。
  • MoneynoteApiApplication.java: 项目的启动类。
• src/main/resources/: 包含项目的配置文件和静态资源。
  • application.properties: 项目的配置文件。
  • static/: 存放静态资源文件。
• src/test/java/com/moneynote/api/: 包含项目的测试代码。
  • MoneynoteApiApplicationTests.java: 项目的测试类。
• Dockerfile: 用于构建 Docker 镜像的文件。
• README.md: 项目的说明文档。
• pom.xml: Maven 项目的配置文件。

2. 项目的启动文件介绍

项目的启动文件是 MoneynoteApiApplication.java，位于 src/main/java/com/moneynote/api/ 目录下。

MoneynoteApiApplication.java

package com.moneynote.api;

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

@SpringBootApplication
public class MoneynoteApiApplication {

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

启动文件介绍

• @SpringBootApplication: 这是一个组合注解，包含了 @Configuration、@EnableAutoConfiguration 和 @ComponentScan 注解，用于简化 Spring Boot 应用的配置。
• main 方法：这是应用程序的入口点，通过调用 SpringApplication.run 方法来启动 Spring Boot 应用。

3. 项目的配置文件介绍

项目的配置文件是 application.properties，位于 src/main/resources/ 目录下。

application.properties

# 服务器配置
server.port=8080

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

# JPA 配置
spring.jpa.hibernate.ddl-auto=update
spring.jpa.show-sql=true
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQL5Dialect

配置文件介绍

• server.port: 指定应用的端口号，默认为 8080。
• spring.datasource.url: 指定数据库的连接 URL。
• spring.datasource.username: 指定数据库的用户名。
• spring.datasource.password: 指定数据库的密码。
• spring.jpa.hibernate.ddl-auto: 指定 Hibernate 的 DDL 模式，update 表示自动更新数据库表结构。
• spring.jpa.show-sql: 指定是否显示 SQL 语句。
• spring.jpa.properties.hibernate.dialect: 指定 Hibernate 的方言，用于优化 SQL