Netty學(xué)習(xí)之Bootstrapping
前言
在前面的內(nèi)容中屋群，我們基本把Netty的核心組件都學(xué)習(xí)完了，各個(gè)組件的作用及組件之間的關(guān)系也基本理清楚了劳曹，一個(gè)完整的Netty應(yīng)用基本上也能寫(xiě)出來(lái)了蝗锥，當(dāng)然何陆，還差最后一步，啟動(dòng)應(yīng)用抵碟，本小節(jié)我們來(lái)學(xué)習(xí)如何啟動(dòng)一個(gè)Netty應(yīng)用桃漾。
Bootstrap Class
Bootstrap類包含兩個(gè)子類，Bootstrap及ServerBootstrap拟逮，分別對(duì)應(yīng)于客戶端應(yīng)用及服務(wù)端應(yīng)用撬统，他們的區(qū)別在于，服務(wù)端需要兩個(gè)Channel敦迄，父Channel用于建立連接恋追，子Channel用于管理已經(jīng)建立的連接。
Bootstrap常用API
-
group()罚屋，指定所要使用的EventLoopGroup -
channel()苦囱，選擇所要使用的channel -
localAddress()，指定所要綁定的地址 -
option()脾猛，設(shè)置ChannelOption -
handler()撕彤，設(shè)置ChannelHandler -
remoteAddress()，設(shè)置遠(yuǎn)程地址 -
connect()猛拴，連接到遠(yuǎn)程服務(wù)羹铅，并且返回一個(gè)ChannelFuture，用于通知結(jié)果 -
bind()愉昆，綁定Channel职员，并且返回一個(gè)ChannelFuture，用于通知綁定結(jié)果
啟動(dòng)客戶端
啟動(dòng)流程基本如下
public void start() {
// 指定EventLoopGroup
EventLoopGroup group = new NioEventLoopGroup();
// 創(chuàng)建Bootstrap
Bootstrap bootstrap = new Bootstrap();
// 綁定所要使用的EventLoopGroup
bootstrap.group(group)
.remoteAddress(new InetSocketAddress(HOST, PORT))
// 指定所要使用的Channel
// 要注意撼唾，Channel的類型必須跟EventLoop的類型相匹配
.channel(NioSocketChannel.class)
// 指定對(duì)應(yīng)的處理器
// 如果只有一個(gè)handler廉邑，也可以直接添加即可
// 使用ChannelInitializer主要是用于添加多個(gè)handler
.handler(new ChannelInitializer<SocketChannel>() {
@Override
protected void initChannel(SocketChannel ch) throws Exception {
ch.pipeline().addLast(new EchoClientHandler());
}
});
try {
ChannelFuture future = bootstrap.connect().sync();
future.channel().closeFuture().sync();
} catch (InterruptedException e) {
e.printStackTrace();
}finally {
try {
group.shutdownGracefully().sync();
} catch (InterruptedException e) {
e.printStackTrace();
}
}
}
需要注意的是哥蔚，啟動(dòng)客戶端，也就是調(diào)用bind()或者connect()之前蛛蒙，必須要配置group()糙箍、channel()/channelFactory()、handler()牵祟，不然會(huì)報(bào)IllegalStateException深夯，其中hanlder()是非常重要的，用于配置處理的邏輯操作诺苹。
在配置的時(shí)候咕晋，要注意指定的group()與channel()必須匹配，如NioEventLoopGroup必須與NioSocketChannel或者NioServerSocketChannel收奔，不能混用Nio與Oio掌呜，不然也會(huì)報(bào)IllegalStateException
可供使用的EventLoopGroup及Channel如下
channel
|--nio
| NioEventLoopGroup
|--oio
| OioEventLoopGroup
|--socket
|--nio
| NioDatagramChannel
| NioServerSocketChannel
| NioSocketChannel
|--oio
| OioDatagramChannel
| OioServerSocketChannel
| OioSocketChannel
啟動(dòng)服務(wù)端
private void start() {
final EchoServerHandler serverHandler = new EchoServerHandler();
// 創(chuàng)建一個(gè)EventLoopGroup--boss
EventLoopGroup boss = new NioEventLoopGroup();
// 創(chuàng)建一個(gè)EventLoopGroup--worker
EventLoopGroup worker = new NioEventLoopGroup();
// ServerBootstrap
ServerBootstrap bootstrap = new ServerBootstrap();
int port = 8888;
// 如果只配置一個(gè)group，則表示同一個(gè)group同于兩個(gè)用途：父Channel坪哄、子Channel
// 如果配置兩個(gè)质蕉，則分別使用啦
bootstrap.group(boss, worker)
// 設(shè)置地址
.localAddress(new InetSocketAddress(port))
// 指定使用NioServerSocketChannel
.channel(NioServerSocketChannel.class)
// 添加子處理器，用于處理建立之后的連接
// 這里需要注意翩肌，handler()方法是用于配置ServerChannel本身
// childHandler()才是用于配置建立的連接
.childHandler(new ChannelInitializer<SocketChannel>() {
@Override
protected void initChannel(SocketChannel ch) {
ch.pipeline().addLast(serverHandler);
}
});
try {
// .sync()表示等待綁定完成模暗，當(dāng)前線程會(huì)阻塞
ChannelFuture future = bootstrap.bind().sync();
// 等待關(guān)閉
future.channel().closeFuture().sync();
} catch (InterruptedException e) {
e.printStackTrace();
}finally {
try {
worker.shutdownGracefully().sync();
boss.shutdownGracefully().sync();
} catch (InterruptedException e) {
e.printStackTrace();
}
}
}
如果需要添加多個(gè)Handler，可以通過(guò)添加一個(gè)ChannelInitialize<T>的實(shí)現(xiàn)類對(duì)象念祭，然后在該對(duì)象的protected vodi initChannel(Channel ch)中通過(guò)channel.pipeline()獲取對(duì)應(yīng)的pipeline兑宇，然后通過(guò)pipeline注冊(cè)多個(gè)handler。
從Channel中啟動(dòng)一個(gè)客戶端
有時(shí)候我們的服務(wù)端也需要充當(dāng)客戶端去連接其他的服務(wù)端粱坤，比如請(qǐng)求oauth授權(quán)隶糕、或者代理等。
可以直接在建立的channel中再起一個(gè)boostrap用于去連接第三方服務(wù)比规，但是這種操作不是很合理若厚，這種方式需要重新起一個(gè)EventLoop(新建一個(gè)Channel，則會(huì)重新綁定了新的EventLoop)蜒什，所以當(dāng)在兩個(gè)不同的channel交換數(shù)據(jù)時(shí)會(huì)帶來(lái)額外的線程開(kāi)銷和上下文切換 测秸。
更好地方式是通過(guò)調(diào)用group()方法，共享已經(jīng)建立連接的EventLoop灾常，這樣子對(duì)應(yīng)的子channel也是在同一個(gè)線程上下文中霎冯，所以避免了上下文切換的消耗。
public class Test {
public static void main(String[] args) {
ServerBootstrap bootstrap = new ServerBootstrap();
EventLoopGroup boss = new NioEventLoopGroup();
EventLoopGroup worker = new NioEventLoopGroup();
bootstrap.group(boss, worker)
.channel(NioServerSocketChannel.class)
.childHandler(new SimpleChannelInboundHandler<ByteBuf>() {
ChannelFuture connectFuture;
/**
* 通道連接建立后钞瀑，建立與第三方的連接
*/
@Override
public void channelActive(ChannelHandlerContext ctx) throws Exception {
// 啟動(dòng)bootstrap充當(dāng)客戶端去連接新的服務(wù)
Bootstrap client = new Bootstrap();
client.channel(NioSocketChannel.class)
.handler(new SimpleChannelInboundHandler<ByteBuf>() {
@Override
protected void channelRead0(ChannelHandlerContext ctx, ByteBuf msg) throws Exception {
System.out.println("Received data: " + msg.toString(CharsetUtil.UTF_8));
}
});
// 重點(diǎn)是這里沈撞，復(fù)用了父channel的eventLoop
client.group(ctx.channel().eventLoop());
connectFuture = client.connect(new InetSocketAddress("www.baidu.com", 80));
}
@Override
protected void channelRead0(ChannelHandlerContext ctx, ByteBuf msg) throws Exception {
// 連接建立完成
if (connectFuture.isDone()) {
// 其他的操作，比如發(fā)送請(qǐng)求等
}
}
});
try {
ChannelFuture future = bootstrap.bind(8080).sync();
future.channel().closeFuture().sync();
} catch (InterruptedException e) {
e.printStackTrace();
}finally {
worker.shutdownGracefully();
boss.shutdownGracefully();
}
}
}
使用ChannelOptions或者attributes
如果手動(dòng)為每個(gè)建立的Channel都進(jìn)行配置雕什，是一件非常痛苦的事情缠俺，所以Netty提供了option()方法用于傳入一個(gè)ChannelOptions對(duì)象显晶，每個(gè)配置會(huì)自動(dòng)應(yīng)用到所有建立的channel中。
此外壹士，Netty還提供了AttributeMap及其子類AttributeKey<T>用于在Channel中傳遞額外的屬性信息磷雇，然后通過(guò)channel#attr("key")可以將attributeKey獲取出來(lái)，然后通過(guò)其get方法就能將對(duì)應(yīng)的屬性值獲取出來(lái)躏救。
public class Test {
public static void main(String[] args) {;
Bootstrap bootstrap = new Bootstrap();
EventLoopGroup group = new NioEventLoopGroup();
// 新建一個(gè)id屬性鍵
final AttributeKey<Integer> id = AttributeKey.newInstance("ID");
bootstrap.group(group)
.channel(NioSocketChannel.class)
.handler(new SimpleChannelInboundHandler<ByteBuf>() {
@Override
protected void channelRead0(ChannelHandlerContext ctx, ByteBuf msg) throws Exception {
// ops
}
@Override
public void channelRegistered(ChannelHandlerContext ctx) throws Exception {
Integer integer = ctx.channel().attr(id).get();
}
});
bootstrap.option(ChannelOption.SO_KEEPALIVE, true)
.option(ChannelOption.CONNECT_TIMEOUT_MILLIS, 5000);
// 設(shè)置屬性鍵及其值
bootstrap.attr(id, 123456);
ChannelFuture future = bootstrap.connect("host", 8080);
future.syncUninterruptibly();
}
}
UDP
在之前的例子中唯笙，我們使用的都是基于TCP的連接方式，Netty3之后盒使，同樣支持UDP連接方式崩掘，只需要使用*DatagramChannel*類，同時(shí)不使用connect()或者bind()即可少办。
public static void main(String[] args) {
Bootstrap bootstrap = new Bootstrap();
bootstrap.group(new OioEventLoopGroup())
.channel(OioDatagramChannel.class)
.handler(new SimpleChannelInboundHandler<DatagramPacket>() {
@Override
protected void channelRead0(ChannelHandlerContext ctx, DatagramPacket msg) throws Exception {
}
});
}
關(guān)閉
關(guān)閉Netty應(yīng)用的時(shí)候苞慢，需要關(guān)閉EventLoopGroup，EventLoopGroup綁定了很多線程嘛英妓，通過(guò)調(diào)用eventLoopGroup.shutdownGracefully()即可枉疼，由于該操作同樣是異步操作，所以要么阻塞鞋拟，要么注冊(cè)一個(gè)監(jiān)聽(tīng)器，該方法會(huì)釋放所有資源并且關(guān)閉所有在使用的Channel惹资，也可以顯示調(diào)用Channel.close()贺纲，然后再關(guān)閉EventLoopGroup
在關(guān)閉的時(shí)候，我們需要根據(jù)情況褪测，看是關(guān)閉當(dāng)前的channel還是關(guān)閉整個(gè)服務(wù)猴誊，如果是關(guān)閉整個(gè)服務(wù)，則應(yīng)該關(guān)閉當(dāng)前channel對(duì)應(yīng)的父channel(對(duì)于服務(wù)端來(lái)說(shuō))侮措，客戶端只需要關(guān)閉當(dāng)前channel即可懈叹。
關(guān)閉之后，Netty會(huì)發(fā)送“關(guān)閉事件”給服務(wù)端分扎，并觸發(fā)對(duì)應(yīng)的事件澄成，即一開(kāi)始我們所編寫(xiě)的
// 綁定地址并且獲取對(duì)應(yīng)的channel，此時(shí)的channel是父channel
ChannelFuture future = bootstrap.bind(PORT).sync();
// 阻塞直至連接關(guān)閉
// 父channel關(guān)閉時(shí)畏吓，該操作會(huì)收到通知墨状，進(jìn)而關(guān)閉應(yīng)用
future.channel().closeFuture().sync();
總結(jié)
本小節(jié)我們主要學(xué)習(xí)了Netty的Boostrap，這個(gè)組件是Netty必備組件的最后一個(gè)組件了菲饼，通過(guò)該組件將前面所有涉及到的組件串聯(lián)起來(lái)肾砂，并且綁定地址，啟動(dòng)服務(wù)或者客戶端宏悦，在Netty中镐确，如果能復(fù)用EventLoop就應(yīng)該盡量復(fù)用EventLoop包吝，從而可以減少線程上下文的切換，比如在服務(wù)端需要重新啟動(dòng)另一個(gè)客戶端的時(shí)候源葫，這時(shí)就可以直接復(fù)用當(dāng)前channel的EventLoop即可诗越。
