SMF Core 快速开始指南

概述

本文档提供SMF Core项目的快速安装、配置和运行指南，帮助开发人员和管理员快速上手系统。

环境要求

• JDK: JDK 1.8 或更高版本
• Maven: Maven 3.6 或更高版本
• 数据库: MongoDB 4.0+
• Redis: Redis 5.0+ (可选，用于缓存)
• IDE: 推荐IntelliJ IDEA或Eclipse
• 操作系统: Windows, Linux 或 macOS

安装步骤

1. 克隆代码仓库

git clone [仓库地址] smf-core
cd smf-core

2. 配置数据库

2.1 MySQL配置

1. 创建数据库：

CREATE DATABASE smf_core DEFAULT CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
CREATE USER 'smf_user'@'localhost' IDENTIFIED BY 'smf_password';
GRANT ALL PRIVILEGES ON smf_core.* TO 'smf_user'@'localhost';
FLUSH PRIVILEGES;

1. 修改数据库连接配置：

编辑 src/main/resources/application-dev.yml 文件，更新数据库连接信息：

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/smf_core?useUnicode=true&characterEncoding=UTF-8
    username: smf_user
    password: smf_password

2.2 MongoDB配置

1. 确保MongoDB服务已启动
2. 修改MongoDB连接配置：

spring:
  data:
    mongodb:
      uri: mongodb://localhost:27017/smf_core

3. 编译项目

使用Maven编译项目：

# 使用Maven包装器
./mvnw clean install

# 或直接使用Maven
mvn clean install

运行项目

方式一：使用Maven直接运行

./mvnw spring-boot:run

方式二：运行编译后的jar包

java -jar target/smf-core-1.0.0.jar

方式三：在IDE中运行

1. 在IntelliJ IDEA中导入项目
2. 找到 com.neotel.smfcore.SmfCoreApplication 类
3. 右键选择 "Run SmfCoreApplication"

访问系统

系统启动成功后，可以通过以下方式访问：

• Web界面: http://localhost:8080/smf-core
• API文档: http://localhost:8080/smf-core/swagger-ui.html
• 健康检查: http://localhost:8080/smf-core/actuator/health

初始配置

1. 创建外部配置目录

在系统启动前，建议创建外部配置目录：

Linux系统：

mkdir -p /opt/smf/config
chmod 755 /opt/smf/config

Windows系统：

创建目录: C:\Program Files\smf\config

2. 配置文件复制

将以下配置文件复制到外部配置目录：

• smfcore.json
• smfclient.json

3. 首次运行初始化

系统首次运行时会自动：

• 创建基础数据表
• 初始化系统配置
• 创建默认管理员账户

默认管理员账户：

• 用户名：admin
• 密码：admin123

常用命令

查看帮助

java -jar target/smf-core-1.0.0.jar --help

指定环境运行

java -jar target/smf-core-1.0.0.jar --spring.profiles.active=prod

指定端口运行

java -jar target/smf-core-1.0.0.jar --server.port=9000

开发环境配置

1. IDE配置（IntelliJ IDEA）

1. 导入Maven项目
2. 配置JDK版本为1.8+
3. 安装Lombok插件（Settings -> Plugins -> 搜索Lombok）
4. 启用注解处理（Settings -> Build -> Compiler -> Annotation Processors -> 勾选Enable annotation processing）

2. 调试配置

在IntelliJ IDEA中配置调试：

1. Run -> Edit Configurations
2. 点击 + 号，选择 Spring Boot
3. 填写名称："SMF Core Debug"
4. 主类选择：com.neotel.smfcore.SmfCoreApplication
5. 环境变量：SPRING_PROFILES_ACTIVE=dev
6. 点击 Apply 和 OK

日志查看

系统日志默认输出到以下位置：

• 控制台
• logs/smf.txt 文件

查看日志：

# Linux/macOS
tail -f logs/smf.txt

# Windows
findstr "ERROR" logs\smf.txt

常见问题排查

1. 端口冲突

如果启动时报错端口被占用，可以：

1. 关闭占用端口的进程
2. 修改配置文件中的端口号
3. 使用命令行参数指定端口

2. 数据库连接失败

检查：

1. 数据库服务是否启动
2. 连接参数是否正确
3. 数据库用户权限是否足够

3. 内存不足

增加JVM内存：

java -Xms512m -Xmx1024m -jar target/smf-core-1.0.0.jar

下一步

1. 查看 了解更多配置选项
2. 查看 了解API使用方法
3. 查看 了解系统架构

支持和反馈

如有问题，请联系开发团队或在项目仓库中提交issue。