Summer 开源项目教程

2024-08-23 12:44:19作者：明树来

这是一个轻量级的、一站式的java游戏服务器框架，也可用于开发简单的web服务。基于netty实现了高性能通讯，支持tcp、http、websocket等协议，支持protobuf、json两种数据格式，支持以配置的形式轻松开启多端口网络服务。支持RPC远程调用，支持以优雅的方式实现远程调用，支持调用超时重试、幂等调用。封装了持久化层，提供数据访问和数据落地接口，支持异步新增、保存、删除数据，支持主键或指定其他字段进行数据缓存。支持简单的ioc，业务层使用依赖注入实现逻辑。封装了伪协程实现方案Promise，可用于解决地狱式回调等问题。支持MVC、领域、ECS架构。

项目地址：https://gitcode.com/gh_mirrors/sum/Summer

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

Summer 项目的目录结构如下：

Summer/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   └── com/
│   │   │       └── swingfrog/
│   │   │           └── summer/
│   │   │               ├── annotation/
│   │   │               ├── config/
│   │   │               ├── event/
│   │   │               ├── exception/
│   │   │               ├── log/
│   │   │               ├── net/
│   │   │               ├── server/
│   │   │               ├── service/
│   │   │               ├── task/
│   │   │               └── util/
│   │   └── resources/
│   │       ├── conf/
│   │       ├── log4j2.xml
│   │       └── application.properties
│   └── test/
│       └── java/
│           └── com/
│               └── swingfrog/
│                   └── summer/
│                       └── test/
├── lib/
├── logs/
├── target/
├── .gitignore
├── LICENSE
├── README.md
└── pom.xml

目录结构介绍

src/main/java/com/swingfrog/summer/：包含项目的核心代码，分为多个子包，如 annotation、config、event 等。
src/main/resources/：包含项目的配置文件和日志配置文件。
src/test/java/com/swingfrog/summer/test/：包含项目的测试代码。
lib/：存放第三方库文件。
logs/：存放日志文件。
target/：存放编译后的文件。
.gitignore：Git 忽略文件配置。
LICENSE：项目许可证。
README.md：项目说明文档。
pom.xml：Maven 项目配置文件。

2. 项目的启动文件介绍

Summer 项目的启动文件位于 src/main/java/com/swingfrog/summer/server/ServerMgr.java。该文件负责启动和管理服务器。

启动文件介绍

ServerMgr.java：包含服务器启动的主要逻辑，通过调用 start() 方法启动服务器。

public class ServerMgr {
    public static void main(String[] args) {
        ServerContext.get().start();
    }
}

3. 项目的配置文件介绍

Summer 项目的配置文件主要位于 src/main/resources/ 目录下。

配置文件介绍

application.properties：包含项目的基本配置，如服务器端口、数据库连接等。

server.port=8080
database.url=jdbc:mysql://localhost:3306/summer
database.username=root
database.password=123456

log4j2.xml：日志配置文件，定义日志的输出格式和级别。

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN">
    <Appenders>
        <Console name="Console" target="SYSTEM_OUT">
            <PatternLayout pattern="%d{HH:mm:ss.SSS} [%t] %-5level %logger{36} - %msg%n"/>
        </Console>
    </Appenders>
    <Loggers>
        <Root level="info">
            <AppenderRef ref="Console"/>
        </Root>
    </Loggers>
</Configuration>