1 Star 0 Fork 39

瑶池潜龍 / Limitart

forked from HankXV / Limitart 
加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

Maven Apache JDK

轻量级快速开发游戏服务器 Limitart

Limitart是以Netty为基础开发的一套可快速实现游戏服务器的轻量级框架,依赖非常少的第三方库、代码量少、上手容易,让你可以非常快速的开发出服务器原型。

3.X快速开始

1.涉及到的类

BinaryServer:服务器主体
BinaryMeta:二进制消息元,主要封装了序列化操作
BinaryMessage:二进制消息,是网络传输的对象,可以传输基本类型和BinaryMeta以及他们的列表
BinaryHandler:消息处理方法,负责把指定的消息路由到指定的方法
BinaryManager:消息处理类注解,负责管理一个模块的所有处理方法,即一组BinaryHandler
BinaryRequestParam:所有消息处理方法必须声明的参数
BinaryMessageFactory:消息工厂,负责管理所有服务器需要处理的消息

2.创建一个消息

    public class BinaryMessageDemo extends BinaryMessage {
    	public String content = "hello limitart!";

    	@Override
    	public short messageID() {
    		return BinaryMessages.createID(0X00, 0X01);
    	}

    }

3.为这个消息创建处理器

    @BinaryManager
    public class BinaryManagerDemo {
    	@BinaryHandler(BinaryMessageDemo.class)
    	public void doMessageDemo(BinaryRequestParam param) {
    		BinaryMessageDemo msg = param.msg();
    		System.out.println(msg.content);
    	}
    }

4.让消息工厂实例化注册消息处理器

    BinaryMessageFactory factory = BinaryMessageFactory.createEmpty().registerManager(BinaryManagerDemo.class);
    // 注意:这里可以调用BinaryMessageFactory.create("[包名]","[自定义实例]")的接口来配合脚本加载器(ScriptLoader)来初始化

5.配置服务器实体

    new BinaryServer.BinaryServerBuilder()
    				.factory(factory)
    				.build()
    				.startServer();

6.开启客户端连接并发送消息

    new BinaryClient.BinaryClientBuilder().remoteAddress(new AddressPair("127.0.0.1", 8888))
            .factory(BinaryMessageFactory.createEmpty()).onConnected((BinaryClient cl, Boolean state) -> {
        if (state) {
            try {
                cl.sendMessage(new BinaryMessageDemo());
            } catch (Exception e) {
            }
        }
    }).build().connect();

7.服务器日志+结果

[main] INFO org.slingerxv.limitart.net.binary.BinaryMessageFactory - register msg org.slingerxv.limitart.net.BinaryMessageDemo at org.slingerxv.limitart.net.BinaryManagerDemo
[main] INFO org.slingerxv.limitart.net.AbstractNettyServer - Limitart-Binary-Server nio init
[nioEventLoopGroup-2-1] INFO org.slingerxv.limitart.net.AbstractNettyServer - Limitart-Binary-Server bind at port:8888
[nioEventLoopGroup-3-1] INFO org.slingerxv.limitart.net.AbstractNettyServer - /127.0.0.1:54062 connected!
hello limitart!

消息编码

消息长度(short,包含消息体长度+2)+消息ID(short)+消息体

模块介绍

base 基础包	
collections 主要是一些游戏中常用的数据结构
fsm 有限状态机
game 游戏相关逻辑整理
logging 日志通用接口
net 网络通信
reflectasm modified from https://github.com/EsotericSoftware/reflectasm
script 脚本热更新
singleton 轻量单例依赖注入
concurrent 并发相关
util 常用的工具包

2.X快速开始

首先,我们需要定义一个网络通信的消息类


	public class BinaryMessageDemo extends Message {
		// transfer of information
		public String info;

		//  message id
		@Override
		public short getMessageId() {
			return 1;
		}
	}

再创建一个处理消息的处理器


	public class BinaryHandlerDemo implements IHandler<BinaryMessageDemo> {

		@Override
		public void handle(BinaryMessageDemo msg) {
			System.out.println("server received message:" + msg.info);
		}

	}

初始化一个消息工厂把消息处理器注册进去


	MessageFactory factory = new MessageFactory().registerMsg(BinaryHandlerDemo.class);

最后实例化一个服务器并且开启服务


			new BinaryServer.BinaryServerBuilder()
				// port
				.addressPair(new AddressPair(8888))
				// register factory
				.factory(factory).build()
				.startServer();

初始化一个客户端,在客户端链接验证通过后发送消息给服务器


			new BinaryClient.BinaryClientBuilder()
				.remoteAddress(new AddressPair("127.0.0.1", 8888))
				.onConnectionEffective(c -> {
					BinaryMessageDemo message = new BinaryMessageDemo();
					message.info = "Hello Limitart!";
					c.sendMessage(message, null);
				}).build()
				.connect();

最后服务器收到了消息

server received message:Hello Limitart!

更新日志

v3.0-alpha
1.对于3.0,主要的改动是网络模块开发由常规的接口、虚拟类的方式更改为注解的方式,隐藏更多细节。
2.在之后的改进中,方向也会变为面向接口开发和事件选择性处理等
3.脚本热加载去掉Groovy,采用原生实现
4.动态编译类型脚本增加自动热加载机制
5.增加一些常用集合(临时实现)
6.增加二进制消息xml协议文件定义示例(binary_msg_proto.xml)和解析(BinaryMessages.readBinaryMessageProtoFile)
7.增加一些游戏中常用的数学算法
v2.1.0-release
1.脚本热加载去掉Groovy,采用原生实现
2.动态编译类型脚本增加自动热加载机制
3.增加一些常用集合(临时实现)
4.增加一些游戏服务器常用的数学算法
v2.0.1-release
1.修复热加载jar包不能替换旧jar包的问题
2.热加载的脚本,如果父类是class,那么不能引用父类protected的字段,作用域由于加载器不同而无法引用,建议使用public方法获取或者把父类字段定义为public
3.状态机计时从State移动到状态机本身
v2.0-release
1.增加敏感词过滤(BadWordUtil)
2.语言本地化(I18NStrings)
3.自定义编码部分增加了protobuf的压缩算法
4.ConsoleServer改名为TelnetServer
5.增加ProtoBuf服务器支持
v2.0-alpha
1.注册消息通过Handler直接注册,而不用指定消息Id和消息本身
2.可以通过扫描包的形式直接注册所有消息
3.消息可以自动序列化了,使用者不用关心序列化过程
4.增加排行榜数据结构
5.回调函数离散化和Lambda化
6.增加扑克和德州扑克的部分操作
7.使用注解方式处理消息(beta版本)
8.增加了jar包脚本的加载和FTP远程加载jar包的方式
9.增加了2种消息队列
10.增加了消息队列组
11.增加了Telnet服务器(ConsoleServer)
12.增加心跳检查和消息接收速度检查
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright (c) 2016-present The Limitart Project Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

轻量级高性能少依赖的游戏服务器开发框架 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/umosun/Limitart.git
git@gitee.com:umosun/Limitart.git
umosun
Limitart
Limitart
3.x

搜索帮助