开源项目 miru-project 使用教程

开源项目 miru-project 使用教程

repoMiru Repository 项目地址:https://gitcode.com/gh_mirrors/repo1/repo

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

miru-project/
├── docs/
│   ├── README.md
│   └── CONTRIBUTING.md
├── src/
│   ├── main/
│   │   ├── java/
│   │   └── resources/
│   └── test/
│       ├── java/
│       └── resources/
├── config/
│   ├── application.properties
│   └── logback.xml
├── scripts/
│   ├── setup.sh
│   └── deploy.sh
├── .gitignore
├── LICENSE
└── README.md

• docs/: 包含项目的文档文件，如 README.md 和 CONTRIBUTING.md。
• src/: 项目的源代码目录，分为 main 和 test 两个子目录，分别存放主代码和测试代码。
• config/: 项目的配置文件目录，包括 application.properties 和 logback.xml。
• scripts/: 包含项目的脚本文件，如 setup.sh 和 deploy.sh。
• .gitignore: Git 忽略文件列表。
• LICENSE: 项目的许可证文件。
• README.md: 项目的主文档文件。

2. 项目的启动文件介绍

项目的启动文件通常位于 src/main/java/ 目录下，具体路径取决于项目的结构。假设项目的启动类为 com.example.MainApplication，则启动文件为：

package com.example;

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

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

• @SpringBootApplication: 这是一个组合注解，包含了 @Configuration, @EnableAutoConfiguration, 和 @ComponentScan。
• main 方法: 项目的入口点，启动 Spring Boot 应用。

3. 项目的配置文件介绍

项目的配置文件位于 config/ 目录下，主要包括 application.properties 和 logback.xml。

application.properties

server.port=8080
spring.datasource.url=jdbc:mysql://localhost:3306/mydb
spring.datasource.username=root
spring.datasource.password=root
spring.jpa.hibernate.ddl-auto=update
logging.level.root=INFO

• server.port: 指定应用的端口号。
• spring.datasource: 配置数据库连接信息。
• spring.jpa.hibernate.ddl-auto: 配置 Hibernate 的 DDL 策略。
• logging.level.root: 配置日志级别。

logback.xml

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

    <root level="info">
        <appender-ref ref="STDOUT" />
    </root>
</configuration>

• appender: 定义日志输出方式，这里是输出到控制台。
• encoder: 定义日志格式。
• root level: 定义根日志级别。

repoMiru Repository 项目地址:https://gitcode.com/gh_mirrors/repo1/repo