Xian 开源项目使用教程

Xian 开源项目使用教程

xianreactive风格的微服务框架项目地址:https://gitcode.com/gh_mirrors/xia/xian

1. 项目目录结构及介绍

xian/
├── docs/
│   ├── README.md
│   └── ...
├── src/
│   ├── main/
│   │   ├── java/
│   │   └── resources/
│   └── test/
│       ├── java/
│       └── resources/
├── config/
│   ├── application.properties
│   └── ...
├── scripts/
│   ├── start.sh
│   └── ...
├── pom.xml
└── ...

目录结构说明

• docs/: 存放项目的文档文件，包括 README.md 等。
• src/: 项目的源代码目录，包含 main/ 和 test/ 两个子目录。
  • main/: 存放项目的主要代码。
    • java/: Java 源代码文件。
    • resources/: 资源文件，如配置文件、模板文件等。
  • test/: 存放项目的测试代码。
    • java/: 测试代码文件。
    • resources/: 测试资源文件。
• config/: 存放项目的配置文件，如 application.properties。
• scripts/: 存放项目的启动脚本，如 start.sh。
• pom.xml: Maven 项目的配置文件。

2. 项目启动文件介绍

启动脚本

项目提供了一个启动脚本 scripts/start.sh，用于启动项目。该脚本通常包含以下内容：

#!/bin/bash

# 设置环境变量
export JAVA_HOME=/path/to/java

# 启动项目
java -jar target/xian.jar

启动命令

在项目根目录下，可以通过以下命令启动项目：

./scripts/start.sh

3. 项目配置文件介绍

配置文件路径

项目的配置文件主要存放在 config/ 目录下，其中最重要的配置文件是 application.properties。

配置文件内容

application.properties 文件通常包含以下内容：

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

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

# 日志配置
logging.level.root=INFO

配置文件说明

• 数据库配置: 配置数据库的连接信息，包括 URL、用户名和密码。
• 服务器端口配置: 配置服务器的监听端口。
• 日志配置: 配置日志的输出级别。

通过以上配置，可以灵活地调整项目的运行环境。

xianreactive风格的微服务框架项目地址:https://gitcode.com/gh_mirrors/xia/xian