Baton 开源项目使用教程

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

Baton 项目的目录结构如下：

baton/
├── bin/
│   └── baton
├── conf/
│   ├── baton.conf
│   └── logging.conf
├── lib/
│   └── baton.jar
├── logs/
│   └── baton.log
├── src/
│   ├── main/
│   │   ├── java/
│   │   └── resources/
│   └── test/
│       ├── java/
│       └── resources/
├── README.md
└── pom.xml

目录结构介绍

• bin/: 存放项目的可执行文件，如 baton 启动脚本。
• conf/: 存放项目的配置文件，如 baton.conf 和 logging.conf。
• lib/: 存放项目的依赖库文件，如 baton.jar。
• logs/: 存放项目的日志文件，如 baton.log。
• src/: 存放项目的源代码，包括主代码和测试代码。
  • main/: 存放主代码。
    • java/: 存放 Java 源代码。
    • resources/: 存放资源文件。
  • test/: 存放测试代码。
    • java/: 存放测试 Java 源代码。
    • resources/: 存放测试资源文件。
• README.md: 项目的说明文档。
• pom.xml: Maven 项目的配置文件。

2. 项目的启动文件介绍

项目的启动文件位于 bin/ 目录下，文件名为 baton。该文件是一个可执行脚本，用于启动 Baton 项目。

启动文件内容

#!/bin/bash

# 设置 Java 环境变量
export JAVA_HOME=/usr/lib/jvm/java-8-openjdk-amd64
export PATH=$JAVA_HOME/bin:$PATH

# 设置项目路径
BASE_DIR=$(dirname "$0")
CONF_DIR=$BASE_DIR/../conf
LIB_DIR=$BASE_DIR/../lib

# 启动命令
java -cp $LIB_DIR/baton.jar:$CONF_DIR -Dconfig.file=$CONF_DIR/baton.conf com.americanexpress.baton.Main

启动步骤

1. 确保系统中已安装 Java 环境。
2. 进入 bin/ 目录。
3. 执行 ./baton 启动项目。

3. 项目的配置文件介绍

项目的配置文件位于 conf/ 目录下，主要包括 baton.conf 和 logging.conf。

baton.conf

baton.conf 是 Baton 项目的主配置文件，用于配置项目的各项参数。

# 数据库配置
db.url=jdbc:mysql://localhost:3306/baton
db.username=root
db.password=password

# 日志配置
log.level=INFO
log.file=/var/log/baton/baton.log

# 其他配置
server.port=8080
server.host=0.0.0.0

logging.conf

logging.conf 是日志配置文件，用于配置项目的日志输出。

# 日志级别
.level=INFO

# 日志输出格式
handlers=java.util.logging.FileHandler, java.util.logging.ConsoleHandler

java.util.logging.FileHandler.pattern=/var/log/baton/baton.log
java.util.logging.FileHandler.limit=50000
java.util.logging.FileHandler.count=1
java.util.logging.FileHandler.formatter=java.util.logging.SimpleFormatter

java.util.logging.ConsoleHandler.level=INFO
java.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter

配置文件说明

• db.url: 数据库连接 URL。
• db.username: 数据库用户名。
• db.password: 数据库密码。
• log.level: 日志级别，如 INFO、DEBUG 等。
• log.file: 日志文件路径。
• server.port: 服务器端口。
• server.host: 服务器主机地址。

通过以上配置文件，可以灵活地调整 Baton 项目的运行参数和日志输出。