使用Spring+Maven配置Netty4

最新推荐文章于 2025-06-21 11:22:35 发布

13东倍

最新推荐文章于 2025-06-21 11:22:35 发布

阅读量2.8w

点赞数 1

maven 同时被 3 个专栏收录

4 篇文章

订阅专栏

spring

4 篇文章

订阅专栏

netty

3 篇文章

订阅专栏

本文介绍如何使用 Spring3.2 和 Maven 配置 Netty4 的过程，包括创建 ServerBootstrap 对象、设置 ChannelOption 以及使用纯 Java 配置替代 XML 文件等关键步骤。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

使用Spring+Maven配置Netty4

原文:http://nerdronix.blogspot.com/2013/06/netty-4-configuration-using-spring-maven.html (需要翻墙)

本文介绍如何使用Spring3.2和Maven配置Netty 4. 源码在github. Spring的配置使用的是纯Java配置没有涉及xml文件. 在本文的最后, 也会有相应的xml文件的配置.

Netty

为了创建一个netty服务端, 通常我们需要以下几个步骤:

创建ServerBootstrap对象
设置参数像bossGroup, workerGroup, childHandler以及设置ChannelOption就像keep_alive针对bootstrap.
使用bootstrap创建channel.
确保可以退出程序, 你调用shutDownGracefully方法或者相似的方法.

现在假设你已经在Spring中创建了bootstrap, 下面这几行代码足够启动服务端以及关闭.

 
@PostConstruct
 
public void start() throws Exception {
 
    serverChannel = b.bind(tcpPort).sync().channel().closeFuture().sync().channel()
 
}
 
 
 
@PreDestroy
 
public void stop() {
 
    serverChannel.close();
 
}

其中的"b"就是bootstrap通过Spring注入得到. 你可以查看完整代码TCPServer.

Spring

涉及到一点针对Netty的Spring配置. 必须配置ServerBootstrap, ChannelInitializer和ChannelOption以及一些解码器和编码器, 这个例子更加的深入. 这几行代码是Spring配置的说明. 完整代码在SpringConfig

注解

 
@Configuration
 
@ComponentScan("org.nerdronix")
 
@PropertySource("classpath:netty-server.properties")
 
public class SpringConfig { ...

@Configuration注解确保java文件可以像近似于Spring的application-context.xml文件一样的方式处理. 组件扫描特性被用来设置通过Spring将被扫描到的一个或多个包自动装配. 注意任何需要被Spring管理的POJO都应该带上@Component注意或者子注解. 稍后会有更多关于@PropertySource注解.
现在我们往下到第2步, 即真实的bean发生在SpringConfig中的初始化过程.

Bean的创建

下面的代码展示如何创建一个bean.

 
@Bean(name = "bossGroup", destroyMethod = "shutdownGracefully")
 
public NioEventLoopGroup bossGroup() {
 
    return new NioEventLoopGroup(bossCount);
 
}

@Bean注解被用来表示这个方法将会返回一个bean, 注解的destroyMethod参数意味着Spring退出时将被调用. 这是个可选参数, 连"name"都是可选的. 因此bossCount来自哪里? 我们到第3步, 去解释下.

PropertySource的配置.

Spring3.1引入了一种方法, 即使用下面这两个注解, @PropertySource和@Value, 可以用很简单的方式注意一个bean的属性.

 
@PropertySource("classpath:netty-server.properties")
 
...
 
...
 
@Value("${boss.thread.count}")
 
private int bossCount;

另外对于纯java的配置方案, 你还需要在SpringConfig类中设置接下来的bean, 否则这些不会被@Value注解正确的评估.

 
/**
 
* Necessary to make the @Value annotations work.
 
*
 
*/
 
@Bean
 
public static PropertySourcesPlaceholderConfigurer propertyPlaceholderConfigurer() {
 
    return new PropertySourcesPlaceholderConfigurer();
 
}

在netty-server.properties文件中相应的条目是boss.thread.count=2. 注意Spring将自动转换由string到integer, 这种做法针对所有常见数据类型, 所以你不需要调用Integer.valueOf(string).

设置Netty Bootstrap

下面的代码片断展示netty bootstrap如何设置.

 
@Bean(name = "serverBootstrap")
 
public ServerBootstrap bootstrap() {
 
    ServerBootstrap b = new ServerBootstrap();
 
    b.group(bossGroup(), workerGroup())
 
        .channel(NioServerSocketChannel.class)
 
        .childHandler(protocolInitalizer);
 
    Map, Object> tcpChannelOptions = tcpChannelOptions();
 
    Set> keySet = tcpChannelOptions.keySet();
 
    for (@SuppressWarnings("rawtypes")
 
        ChannelOption option : keySet) {
 
            b.option(option, tcpChannelOptions.get(option));
 
    }
 
    return b;
 
}

protocolInitalizer你可以找到真实的POJO,位于另一个包的这里. 那么我们如何在SpringConfig类中得到这个bean? 答案是SpringConfig的@Configuration注解也继承了@Component注解意味着SpringConfig也是一个 Spring类, 而且我们可以自动装配其他bean到这个bean, 就像任何其他的普通Spring bean.
下面几行SpringConfig文件中的代码可以做好这件事

 
@Autowired
 
@Qualifier("springProtocolInitializer")
 
private StringProtocolInitalizer protocolInitalizer;

控制反转的好处是所有的bean被默认是单例你不需要花费任何精力, spring的组件扫描功能会负责自动写程序并且使用@PropertySource和@Value注解属性被轻松的注入. 依照接口编程的示例你可以让你的代码成为真正的模块.

Maven

pom相当的清晰; 你需要添加针对Spring, netty和logging的依赖库让他工作. 主要的依赖库会在下面提供, 父级的pom包括所有的版本和常用依赖库.

 
<dependency>
 
    <groupId>io.netty</groupId>
 
    <artifactId>netty-all</artifactId>
 
    <version>${netty.version}</version>
 
</dependency>
 
 
 
<dependency>
 
    <groupId>org.springframework</groupId>
 
    <artifactId>spring-context</artifactId>
 
    <version>${org.springframework.version}</version>
 
</dependency>

最后, 运行!

找到Main类执行他, Netty服务端应该启动并监听在netty-server.properties文件中设置的端口, 即localhost:8090.

我想要XML!

好吧, 你还是在2009年噢! 实际上, 我仍然热爱针对bean的关系图的XML文件并且使用工具构建, 虽然纯Java的选项肯定赢我. 不管怎么样, 在这: 虽然不是完整的例子但是他展示的是最有意义的bean.

 
<dependency>
 
    <groupId>io.netty</groupId>
 
    <artifactId>netty-all</artifactId>
 
    <vers<bean id="bossGroup" class="io.netty.channel.nio.NioEventLoopGroup">
 
        <constructor-arg type="int" index="0" value="${boss.thread.count}" />
 
        <constructor-arg index="1" ref="bossThreadFactory" />
 
        </bean>
 
 
 
        <bean id="workerGroup" class="io.netty.channel.nio.NioEventLoopGroup">
 
            <constructor-arg type="int" index="0" value="${worker.thread.count}" />
 
            <constructor-arg index="1" ref="workerThreadFactory" />
 
        </bean>
 
 
 
        <bean id="bossThreadFactory" class="org.nerdronix.NamedThreadFactory">
 
            <constructor-arg type="String" value="Server-Boss" />
 
        </bean>
 
 
 
        <bean id="workerThreadFactory" class="org.nerdronix.NamedThreadFactory">
 
            <constructor-arg type="String" index="0" value="Server-Worker" />
 
        </bean>
 
 
 
           
 
            <!-- Netty options for server bootstrap -->
 
        <util:map id="tcpChannelOptions" map-class="java.util.HashMap">
 
            <entry>
 
                <key><util:constant static-field="io.netty.channel.ChannelOption.SO_KEEPALIVE"/></key>
 
                <value type="java.lang.Boolean">${so.keepalive}</value>
 
            </entry>
 
            <entry>
 
                <key><util:constant static-field="io.netty.channel.ChannelOption.SO_BACKLOG"/></key>
 
                <value type="java.lang.Integer">${so.backlog}</value>
 
            </entry>
 
        </util:map>
 
</dependency>