3 Star 3 Fork 2

fbb / nettyx

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

Nettyx

鸣谢

首先谢谢家人, 给了我充足的时间专注在此项目上, 然后感谢JetBrain赠送的Ultimate Edition版的Idea, 最后谢谢自己. 希望此框架能够为大家节省哪怕一分钟的开发时间

链接

JetBrain官网: https://www.jetbrains.com
Github地址: https://github.com/fbbzl/nettyx
Gitee地址: https://gitee.com/fbbzl/nettyx
更多使用案例: https://blog.csdn.net/fbbwht

介绍

基于[netty4.1.X.Final]进行了超轻量级的封装, 提供了一些工具和基础模板, 并额外提供串口通信模板, 帮助你快速搭建基于netty的服务端/客户端应用 及 基于串口的应用

安装教程

  1. 在项目添加以下依赖包:

<dependency>
    <groupId>io.github.fbbzl</groupId>
    <artifactId>nettyx</artifactId>
    <version>2.2.22-RELEASE</version>
</dependency>

api

action                              包含足够的功能接口来支持nettyx函数式编程
  ---Actions                        操作泛型实用程序                                           
  ---ChannelAction                      
  ---ChannelBindAction
  ---ChannelConnectAction
  ---ChannelEventAction
  ---ChannelExceptionAction
  ---ChannelFutureAction
  ---ChannelHandlerContextAction
  ---ChannelPromiseAction
  ---ChannelReadAction
  ---ChannelWriteAction
codec                              提供了一些基本的编解码器
  ---DelimiterBasedFrameCodec          基于分隔符编解码器
  ---EscapeCodec                       协议敏感字替换,例如转义
  ---StartEndFlagFrameCodec            Start End Flag 编解码器,用于根据开始和结束标志对消息进行解码
  ---StringMessageCodec                字符串编解码器
endpoint
  client
     jsc
       support                         jsc对netty的支持实现
       ---MultiJscChannelClient        多jsc通道客户端 
       ---SingleJscChannelClient       单jsc通道客户端
     rxtx
       support                        重写了RxtxChannel, 提供了异步读取的方法, 读取将不会在阻塞发送
       ---MultiRxtxChannelClient        多rxtx通道客户端 
       ---SingleRxtxChannelClient       单rxtx通道客户端
     tcp
       ---MultiTcpChannelClient         多tcp通道客户端 
       ---SingleTcpChannelClient        单tcp通道客户端
     ---AbstractMultiChannelClient      多通道客户端的抽象父类    
     ---AbstractSingleChannelClient     单通道客户端的抽象父类
     ---Client                          客户端顶级抽象父类
  server
     ---TcpServer
envet                                为网络事件提供支持
  ---ChannelEvent                     Channel 事件对象,建议与 Spring 容器事件结合使用
  ---ChannelEvents                    通道事件对象工具
exception                           异常扩展
  ---HandlerException
  ---NoSuchPortException
  ---ParameterizedTypeException
  ---SerializeException
  ---TooLessBytesException
  ---TypeJudgmentException
handler                             提供了一些基本的通道处理程序实现
  interceptor
     ---ChannelInterceptor                信道拦截器,适用于通信前握手等预操作
     ---ChannelInterceptors               通道拦截器实用程序
  ---ActionIdleStateHandler            可操作的空闲状态处理程序
  ---ActioneReadTimeoutHandler         可操作的 读取超时 处理程序
  ---ActionWriteTimeoutHandler         可操作的 写超时 处理程序
  ---ChannelAdvice                     包含入站建言和出站建言
  ---IdledHeartBeater                  闲置后的心跳器
  ---LoggerHandler                     进入和退出消息日志
  ---MessageFilter                     用于过滤消息
listener
  ---ActionableChannelFutureListener   可操作的频道未来侦听器
serializer                             序列化工具
  struct
     annotation
        ---Ignore                      序列化时忽略此字段
        ---Struct                      在序列化中,需要对域类型进行注释,类似于 JPA 中的 @Entity
        ---ToArray                     数组序列化器
        ---ToArrayList                 ArrayList序列化器
        ---ToLinkedList                ToLinkedList序列化器
        ---ToNamedEnum                 Named Enum序列化器
        ---ToString                    String序列化器
     basic
        c                              内置的C基础类型
        cpp                            内置的Cpp基础类型
        ---Basic                       基础类型顶级父类
     ---StructFieldHandler             字段处理器
     ---StructSerializer               核心结构体序列化器
     ---StructSerializerContext        struct 序列化器的上下文,包含 handler-instance、type cache等等
     ---StructUtils                    序列化工具
     ---TypeRefer                      结构泛型类型应用
  xml
     dtd
        ---Dtd                         xml序列化器定义
     handler
        ---EnumHandler                 
        ---NumberHandler             
        ---PropHandler                 顶级的xml prop处理器
        ---PropTypeHandler             处理prop-type的处理器
        ---StringHandler             
        ---SwitchHandler             
     ---XmlSerializer                  从xml中读取配置, 然后序列化成LinkedMap
     ---XmlSerializerContext           xml序列化器的上下文
     ---XmlUtils        
  ---Serializer.java                    顶级序列化器接口
ssl
  ---OpenSslContextFactory           OpenSSL 上下文工厂
  ---SslContextFactory               SSL 上下文工厂
util                                 基础工具
  ---Bins                            二进制工具
  ---ChannelStorage                  存储通道,内部使用 KV 对进行存储
  ---CommPorts                       串口工具
  ---EndianKit                       字节工具  
  ---Exceptions                      异常工具
  ---HexKit                          16进制工具
  ---Throws                          建言工具
  ---Try                             lambda受检异常工具
  
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 [yyyy] [name of copyright owner] 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.

简介

对netty4.1x 进行了超轻量级封装, 提供了tcp客户端/服务端的基础模板, 串口通信的基础模板, 以及业内通用的工具扩展集, 并提供了丰富的函数式接口 展开 收起
Java 等 2 种语言
Apache-2.0
取消

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/fbbzl/nettyx.git
git@gitee.com:fbbzl/nettyx.git
fbbzl
nettyx
nettyx
main

搜索帮助