netty源码构建

ゞ浴缸里的玫瑰 2022-12-25 04:57 238阅读 0赞

# netty源码构建 #

## 构建步骤 ##

github源代码地址：`https://github.com/netty/netty`。

使用git clone：`git clone git@github.com:netty/netty.git`。

$ git clone git@github.com:netty/netty.git
    Cloning into 'netty'...
    Warning: Permanently added the RSA host key for IP address '192.30.255.112' to the list of known hosts.
    remote: Enumerating objects: 67, done.
    remote: Counting objects: 100% (67/67), done.
    remote: Compressing objects: 100% (40/40), done.
    remote: Total 301597 (delta 11), reused 44 (delta 1), pack-reused 301530
    Receiving objects: 100% (301597/301597), 64.61 MiB | 568.00 KiB/s, done.
    Resolving deltas: 100% (128988/128988), done.
    Checking out files: 100% (3100/3100), done.

下载后的源码目录如下：

$ ls -a
    ./               LICENSE.txt
    ../              microbench/
    .fbprefs         mvnw*
    .git/            mvnw.cmd
    .gitattributes   nohttp-checkstyle.xml
    .github/         nohttp-checkstyle-suppressions.xml
    .gitignore       NOTICE.txt
    .idea/           pom.xml
    .lgtm.yml        README.md
    .mvn/            resolver/
    all/             resolver-dns/
    bom/             resolver-dns-native-macos/
    buffer/          run-example.sh*
    codec/           SECURITY.md
    codec-dns/       tarball/
    codec-haproxy/   target/
    codec-http/      testsuite/
    codec-http2/     testsuite-autobahn/
    codec-memcache/  testsuite-http2/
    codec-mqtt/      testsuite-native-image/
    codec-redis/     testsuite-native-image-client/
    codec-smtp/      testsuite-osgi/
    codec-socks/     testsuite-shading/
    codec-stomp/     transport/
    codec-xml/       transport-blockhound-tests/
    common/          transport-native-epoll/
    CONTRIBUTING.md  transport-native-kqueue/
    dev-tools/       transport-native-unix-common/
    docker/          transport-native-unix-common-tests/
    example/         transport-rxtx/
    handler/         transport-sctp/
    handler-proxy/   transport-udt/
    license/

一个标准的maven工程。

可以注释掉xml中一下test工程：

... ...
        <module>tarball</module>
        <module>transport</module>
    
        <module>transport-native-unix-common</module>
        <module>transport-native-epoll</module>
        <module>transport-native-kqueue</module>
        <module>transport-rxtx</module>
        <module>transport-sctp</module>
        <module>transport-udt</module>
        <module>handler</module>
        <module>handler-proxy</module>
        <module>example</module>
    
    
    
    
    
    
    
    
        <module>microbench</module>
        <module>bom</module>
      </modules>
    ... ...

下面使用maven对项目进行构建：

$ mvn clean install -Dmaven.test.skip=true -Dcheckstyle.skip=true

maven命令中跳过测试和检查代码。

使用IDEA导入项目，只需要导入根目录下的pom.xml，其他子目录的pom.xml不要去勾选，如`common/dependency-reduced-pom.xml`。

打开example目录, 运行里面的例子，验证是否构建成功，例如运行：`io.netty.example.echo.EchoServer`。

## 其他玩法 ##

目标：

1.  可以直接在其他工程下，阅读netty的源码（而不是idea自动从jar包解压出来展示）。
2.  除了可以看到netty本身自带的注释以外，还可以自己添加代码注释，方便后续阅读。

下载`netty-all-4.1.54.Final-sources.jar`，然后解压，这里解压后的目录为`C:\development\project\netty-all-4.1.54.Final-sources`。

然后在IDEA中给`netty-all-4.1.54.Final.jar`添加源码关联，快捷键`ctl+shift+alt+s`进入项目设置：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMjI4MTI4NDk_size_16_color_FFFFFF_t_70_pic_center]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMjI4MTI4NDk_size_16_color_FFFFFF_t_70_pic_center]: /images/20221120/8432ba32e3574e48adb4607bd655fd5c.png