him-netty 开源项目安装与使用教程

him-netty 开源项目安装与使用教程

him-netty 开源的H5即时聊天系统 spring-boot + netty + protobuf + vue ~ 项目地址: https://gitcode.com/gh_mirrors/hi/him-netty

1. 项目目录结构及介绍

him-netty 是一个基于 spring-boot、netty、protobuf 和 vue 的开源 H5 即时聊天系统。项目的目录结构如下：

him-netty/
├── him-api/
│   ├── src/
│   └── pom.xml
├── him-common/
│   ├── src/
│   └── pom.xml
├── protocol/
│   ├── proto/
│   └── proto.bat
├── scripts/
│   └── him.sql
├── deepsource.toml
├── .gitignore
├── LICENSE
├── LICENSE_CN
├── MyGenerate POJOs.groovy
├── README.md
└── pom.xml

目录结构介绍

• him-api/: 包含项目的 API 服务代码和相关配置文件。
• him-common/: 包含项目的公共代码和工具类。
• protocol/: 包含项目的 protobuf 协议文件和生成脚本。
• scripts/: 包含项目的 SQL 脚本文件。
• deepsource.toml: 项目代码质量检查配置文件。
• .gitignore: Git 忽略文件配置。
• LICENSE: 项目开源协议文件。
• LICENSE_CN: 项目开源协议中文版文件。
• MyGenerate POJOs.groovy: 自动生成 POJO 类的 Groovy 脚本。
• README.md: 项目说明文档。
• pom.xml: 项目的 Maven 配置文件。

2. 项目启动文件介绍

项目的启动文件位于 him-api/src/main/java/com/lmxdawn/him/api/HIMApiApplication.java。该文件是 Spring Boot 应用程序的入口点，负责启动整个应用程序。

package com.lmxdawn.him.api;

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

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

启动步骤

1. 确保已经安装了 JDK 8 和 Maven。
2. 克隆项目到本地：

   git clone https://github.com/lmxdawn/him-netty.git
   

3. 进入项目目录：

   cd him-netty
   

4. 打包项目：

   mvn -Dmaven.test.skip=true clean package
   

5. 启动项目：

   java -jar him-api/target/him-api-0.0.1-SNAPSHOT.jar
   

3. 项目配置文件介绍

项目的配置文件主要位于 him-api/src/main/resources/ 目录下，包括 application.properties 和 application-dev.properties 等。

主要配置文件

• application.properties: 主配置文件，包含项目的通用配置。
• application-dev.properties: 开发环境配置文件。
• application-pro.properties: 生产环境配置文件。

配置项示例

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

# 跨域配置
him.cors.allowed-origins=*
him.cors.allowed-methods=GET,POST,PUT,DELETE,OPTIONS

# QQ 互联配置
qq.auth.appid=your_appid
qq.auth.appkey=your_appkey

配置文件加载

在启动项目时，可以通过 --spring.profiles.active 参数指定加载的配置文件，例如：

java -jar him-api/target/him-api-0.0.1-SNAPSHOT.jar --spring.profiles.active=pro

这将加载 application-pro.properties 文件中的配置。

总结

通过本教程，您应该已经了解了 him-netty 项目的目录结构、启动文件和配置文件的基本信息。接下来，您可以根据项目的 README.md 文件进一步了解项目的详细功能和使用方法。

him-netty 开源的H5即时聊天系统 spring-boot + netty + protobuf + vue ~ 项目地址: https://gitcode.com/gh_mirrors/hi/him-netty