基于Netty从零开始搭建游戏服务器框架

一、Java环境配置

1.下载JDK

JDK8下载地址：https://www.oracle.com/java/technologies/javase/javase-jdk8-downloads.html

根据操作系统选择需要的相应版本即可

2.window 和 Linux 上的安装配置

2.1 window 环境

下载后JDK的安装根据提示进行，还有安装JDK的时候也会安装JRE，一并安装就可以了。
安装JDK，安装过程中可以自定义安装目录等信息，例如选择安装目录为 d:\Program Files (x86)\Java\jdk8

配置环境变量
1.安装完成后，右击"我的电脑"，点击"属性"，选择"高级系统设置"；
2.选择"高级"选项卡，点击"环境变量"；
3.在 "系统变量" 中新建2项属性，JAVA_HOME、CLASSPATH；
JAVA_HOME : D:\Program Files\Java\jdk8\jdk1.8.0_261
CLASSPATH : .;%JAVA_HOME%\lib\dt.jar;%JAVA_HOME%\lib\tools.jar;
4.在 "系统变量" 中设置 Path 变量，在里面添加
%JAVA_HOME%\bin;%JAVA_HOME%\jre\bin;
5.在cmd窗口输入 java -version 查看是否配置好，出现版本号表示配置成功

2.2 Linux 环境

1.创建一个 /user/local/java 目录，把下载的jdk-8u261-linux-x64.tar.gz包放入
2.解压jdk包，会解压到 jdk1.8.0_261 目录中
3.配置环境变量，可以在多个地方配置比如 ~/.bashrc，/etc/profile 等，我这选择在/etc/profile添加

export JAVA_HOME=/usr/local/java/jdk1.8.0_231
export PATH=$PATH:$JAVA_HOME/bin
export CLASSPATH=.:$JAVA_HOME/lib/dt.jar:$JAVA_HOME/lib/tools.jar
export JRE_HOME=$JAVA_HOME/jre

4.执行 source /etc/profile
5.使用 java -version 查看是否配置好，出现版本号表示配置成功

二、游服框架搭建

1.开发环境

开发工具使用 IntelliJ IDEA 2019.2
项目使用 maven 管理，maven中央仓库(https://search.maven.org/) 需要的依赖包这里下载
IDEA 需要安装 Maven Helper 插件，可以很方便执行相关maven命令
如果不使用IDEA中自带的maven工具，下载一个 apache-maven-3.6.1-bin.zip，下载url
随便放置一个目录中解压出来即可，如目录 F:\Java\apache-maven-3.6.1-bin\apache-maven-3.6.1
配置 maven 环境
5.1 设置环境变量
增加一个 M2_HOME ：F:\Java\apache-maven-3.6.1-bin\apache-maven-3.6.1
在 Path 中添加 F:\Java\apache-maven-3.6.1-bin\apache-maven-3.6.1\bin;
5.2 配置 conf/setting.xml
a. 在 localRepository 项中可以设置自己的本地仓库路径，如 D:\tools\repository，也可使用默认，默认位置在 ${user.home}/.m2/repository
b. 默认的中央仓库很慢有时候甚至连接不通，添加阿里云等镜像，添加镜像仓库的配置，在mirrors节点下面添加子节点：

    
    
        alimaven
        central
        aliyun maven
        http://maven.aliyun.com/nexus/content/repositories/central/
    

    
    
        repo1
        central
        Human Readable Name for this Mirror.
        http://repo1.maven.org/maven2/
    

    
    
        repo2
        central
        Human Readable Name for this Mirror.
        http://repo2.maven.org/maven2/

c. 标签下添加一个标签，修改maven默认的JDK版本

IDEA下配置Maven
File | Settings | Build, Execution, Deployment | Build Tools | Maven 下面设置
a. Maven home directory 选择刚刚解压的maven路径 F:\Java\apache-maven-3.6.1-bin\apache-maven-3.6.1
b. 勾选Override，修改为自己目录下的settings.xml目录

2.搭建框架

1. 服务说明

游戏服务器一般来说是一组服务，如登陆服务（LoginServer）,网关服务（GateServer）,管理服务（GMServer）,逻辑服务（LogicServer）,DB服务（DBServer），地图服务（MapServer）以及一些其他业务服务等。

2.创建项目

1. 创建一个空项目，比如名称为 HpGameServer 的项目

2. 公共子模块 HpCommon

在HpGameServer项目创建一个公共子模块 HpCommon 这个模块被其他服务共同使用，一些公用的包也可以都加在该模块下就不用每个服务都添加相同的依赖包了，其他服务只需添加 HpCommon 依赖就可以了。在HpGameServer下右键 New | Module 选择 Maven | roject SDK 选择自己安装的jdk1.8 | Next填写GroupId（com.ali.hp.HpCommon）和ArtifactId (HpCommon)

在公共模块下的 pom.xml 添加一下公共依赖包，如netty包，protobuf包，log4j包等等

        
            com.google.protobuf
            protobuf-java
            3.4.0
        

        
            io.netty
            netty-all
            4.1.5.Final
        

        
            org.slf4j
            slf4j-log4j12
            1.7.1

3. 网关服务 HpGateServer

在HpGameServer下右键 New | Module 选择 Maven | roject SDK 选择自己安装的jdk1.8 然后勾选 Create from archetype 选择 maven-archetype-quickstart 它会帮我们快速创建Maven工程模板 | Next填写GroupId（com.ali.hp.HpGateServer）和ArtifactId (HpGateServer)
在网关服务的 pom.xml 下添加 HpCommon 包

    
        com.ali.hp.HpCommon
        HpCommon
        1.0.0

其他服务安装 HpGateServer 服务一样创建即可。

4. 试运行

在 HpGameServer 上右击 | Run Maven | install 全部编译完出现

INFO] HpGameServer ...................................... SUCCESS [  1.010 s]
[INFO] HpCommon ........................................... SUCCESS [  4.188 s]
[INFO] HpGateServer ....................................... SUCCESS [  8.816 s]
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESS
[INFO] ------------------------------------------------------------------------
[INFO] Total time:  14.298 s

表示成功，说明依赖的包都下载OK了。

这时在 HpGateServer | target |HpGateServer-1.0.0.jar | 右键运行会出现

 HpGameServer/HpGateServer/target/HpGateServer-1.0.0.jar中没有主清单属性

但是在 main 方法上可以运行，说明 jar 包没有找到 main 方法。

还有两个地方需要注意下

1.Output Directory 可以统一指定一个路径，这样所有的服务生成的jar包都在这个路径中了，比如指定在项目跟路径下的 out 目录下
2.勾选 Include in project build ,这样在IDEA工具栏上会生成相应的编译配置

测试：在 out 目录下生成的 HpGateServer.jar 右键运行可以正常运行了。这样打jar包就可以部署到任何有java环境的地方运行啦。

3.代码编写

一. HpCommon

公共模块主要包括：

工具类，一些常用功能方法的集合，方便业务处理时调用。
protobuf DSL文件和生成的文件，用于客户端与服务器通信的消息字段定义

自定义协议的编解码处理，自定义协议一般包括固定长度包头 + N字节的包体

a. 客户端与服务器之间的包体稍微复杂一点，包体里面分两部分，一个验证头包和一个真正通信的消息包，验证头包确保数据的正确性和安全性

b. 服务与服务之间的包体稍微简单一点，包体里面不用包括验证头包，但需要有个标记字段来标记是否为进行的protobuf封包

二. HpGateServer

使用netty编写服务端和客户端的代码模式大体比较固定这里举个例子说明，具体细节就不贴代码了，对应网关服务来说，既要编写服务端代码，又要编写客户端代码，它作为客户端与后端其他服务之间的桥梁，它相对其他后端服务来说它的角色就是一个客户端。

服务端代码

public class GateServer {

    private static final Logger log = LoggerFactory.getLogger(GateServer.class);
    private static final short listenPort = 8899;//网关监听端口
    private static final short logicPort = 1111;//逻辑服务端口
    private static final String logicIp = System.getProperty("logicIp"); //逻辑服务ip
    private static GateServer server = new GateServer();
    private Channel logicChannel = null;


    private GateServer(){}

    public static GateServer instance(){
        return server;
    }

    public void init() {

    }

    public void run() throws Exception {
        EventLoopGroup bossGroup = new NioEventLoopGroup(1);
        EventLoopGroup workerGroup = new NioEventLoopGroup(8);

        try {
            ServerBootstrap bootstrap = new ServerBootstrap();
            bootstrap.group(bossGroup, workerGroup)
                    .channel(NioServerSocketChannel.class)
                    .handler(new LoggingHandler(LogLevel.INFO))
                    .childHandler(new ChannelInitializer() {
                        @Override
                        protected void initChannel(SocketChannel socketChannel) throws Exception {
                            ChannelPipeline pipeline = socketChannel.pipeline();
                            pipeline.addLast("pingpong", new IdleStateHandler(30, 0, 0, TimeUnit.SECONDS));
                            pipeline.addLast("msgDecoder", new MsgDecoder(65535, false));
                            pipeline.addLast("msgEncoder", new MsgEncoder(65536, false));
                            pipeline.addLast("gateServerHandler", new GateServerHandler());
                        }
                    })
                    .option(ChannelOption.SO_BACKLOG, 128)
                    .childOption(ChannelOption.SO_KEEPALIVE, true)
                    .childOption(ChannelOption.TCP_NODELAY, true);

            // Bind and start to accept incoming connections.
            ChannelFuture future = bootstrap.bind(listenPort).sync();
            System.out.println("linsten in "+ listenPort);
            // 连接后端
            new ConnBackend().connect(logicIp, logicPort);
            // Wait until the server socket is closed.
            future.channel().closeFuture().sync();
        } finally {
            workerGroup.shutdownGracefully();
            bossGroup.shutdownGracefully();
        }
    }

    public Channel getLogicChannel() {
        return logicChannel;
    }

    public void setLogicChannel(Channel channel) {
        logicChannel = channel;
    }

    public static short getLogicPort() {
        return logicPort;
    }

    public static String getLogicIp() {
        return logicIp;
    }

    public SocketAddress getLogicServerAddr() {
        return new InetSocketAddress(logicIp, logicPort);
    }

}

客户端代码

public class ConnBackend {

    private static final Logger log = LoggerFactory.getLogger(ConnBackend.class);
    private Channel backendChannel = null;


    public Channel getBackendChannel() {
        return backendChannel;
    }

    public void connect(String ip, short port) {
        EventLoopGroup group = new NioEventLoopGroup(1);
        Bootstrap bootstrap = new Bootstrap();

        try {
            bootstrap.group(group);
            bootstrap.channel(NioSocketChannel.class);
            bootstrap.option(ChannelOption.TCP_NODELAY, true);
            bootstrap.option(ChannelOption.SO_KEEPALIVE, true);
            bootstrap.handler(new ChannelInitializer() {
                @Override
                protected void initChannel(Channel ch) {
                    ChannelPipeline pipeline = ch.pipeline();
                    pipeline.addLast("pingpong", new IdleStateHandler(180, 30, 0, TimeUnit.SECONDS));
                    pipeline.addLast("msgDecoder", new MsgDecoder(65536, true));
                    pipeline.addLast("msgEncoder", new MsgEncoder(65536, true));
                    pipeline.addLast("connBackendHandler", new ConnBackendHandler());
                }
            });
            ChannelFuture future = bootstrap.connect(new InetSocketAddress(ip, port)).
                    addListener(new ConnBackendListener()).sync();
            backendChannel = future.channel();
            System.out.println("backendChannel:" + backendChannel);
            future.channel().closeFuture().sync();
        } catch (Exception e) {
            //e.printStackTrace();
            System.err.println("连接后端:[" + ip +":"+ port + "]出错，检查后端是否开启！！！");
        }
    }

}

客户端代码需要注意断开重连的处理，addListener(new ConnBackendListener())添加一个对该通道的监听，断开连接后需要在监听器里再次发起连接

三、可执行程序的部署和运行

1.window 环境

一般来说 window 上运行只是测试而已
1.可以创建一个目录如 /f/game_server, 把生成的各服务的 jar （比如网关服务 HpGateServer.jar）拷贝到该目录
2.在该目录里创建一个 start.bat 文件，内容如下

START "HpGateServer" javaw -Dip=192.168.121.170 -Dxxx -jar HpGateServer.jar  //这个是放在后台运行命令，-D后面是需要的参数，可以根据实际需要填写
rem java -Dip=192.168.121.170 -Dxxx  -jar HpNettyClient.jar // rem是注释，这个命令不会放在后台执行

pause

3.停止在后台运行的程序，在任务管理器中结束掉 java、javaw 进程即可

2.Linux 环境

创建放jar包的目录比如/home/game_server，多组服务可以创建相应的字目录如: gate_server, login_server 等
创建 start.sh 脚本启动服务，内容如下

#!/bin/sh
echo "start game_server======================================================"  

echo "start gate_server"                                        
cd ./gate_server                                        
nohup java -jar HpGateServer.jar  > /dev/null 2>&1 &            
cd ../                                                  

echo "start login_server"                                       
cd ./login_server                                       
nohup java -jar HpLoginServer.jar  > /dev/null 2>&1 &           
cd ../                                                  

ps -ef|grep Hp|grep -v grep

3 . 创建 stop.sh 脚本停止服务，内容如

echo "stop gate_server"
pid=`ps -ef|grep HpGateServer|grep -v _SH|grep -v grep|awk '{print $2}'`
if [ "$pid" == "" ]; then
    echo "gate_server not start"
else
    kill -9 $pid
fi

echo "stop login_server"
pid=`ps -ef|grep HpLoginServer|grep -v grep|awk '{print $2}'`
if [ "$pid" == "" ]; then
    echo "login_server not start"
else
    kill -9 $pid
fi

echo "kill all server OK"