xDoc 项目使用教程

xDoc 项目使用教程

1. 项目目录结构及介绍

xDoc/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/
│   │   │       └── treeleafj/
│   │   │           └── xdoc/
│   │   │               ├── controller/
│   │   │               ├── service/
│   │   │               ├── model/
│   │   │               ├── repository/
│   │   │               └── XDocApplication.java
│   │   └── resources/
│   │       ├── application.properties
│   │       └── static/
│   └── test/
│       └── java/
│           └── com/
│               └── treeleafj/
│                   └── xdoc/
│                       └── XDocApplicationTests.java
├── .gitignore
├── LICENSE
├── README.md
└── pom.xml

目录结构说明

• src/main/java/com/treeleafj/xdoc/: 包含项目的Java源代码。
  • controller/: 存放控制器类，处理HTTP请求。
  • service/: 存放服务类，处理业务逻辑。
  • model/: 存放数据模型类。
  • repository/: 存放数据访问层类，通常用于与数据库交互。
  • XDocApplication.java: 项目的启动类。
• src/main/resources/: 存放项目的资源文件。
  • application.properties: 项目的配置文件。
  • static/: 存放静态资源文件，如CSS、JavaScript等。
• src/test/java/com/treeleafj/xdoc/: 存放项目的测试代码。
  • XDocApplicationTests.java: 项目的测试类。
• .gitignore: Git忽略文件，指定哪些文件或目录不需要被Git管理。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的说明文档。
• pom.xml: Maven项目的配置文件。

2. 项目启动文件介绍

XDocApplication.java

package com.treeleafj.xdoc;

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

@SpringBootApplication
public class XDocApplication {

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

启动文件说明

• XDocApplication.java 是项目的启动类，使用了Spring Boot的@SpringBootApplication注解，表示这是一个Spring Boot应用程序。
• main方法中调用了SpringApplication.run方法，启动Spring Boot应用程序。

3. 项目配置文件介绍

application.properties

# 服务器端口配置
server.port=8080

# 数据库配置
spring.datasource.url=jdbc:mysql://localhost:3306/xdoc
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

# 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、用户名、密码和驱动类名。
• spring.jpa.*: 配置JPA（Java Persistence API）相关设置，如Hibernate的DDL自动更新、SQL显示等。

通过以上配置，项目可以正常启动并连接到数据库。