1 Star 0 Fork 92

Dream of freedom / HServer-JAVA

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

HServer

如果对您有帮助,您可以点右上角 "Star" 支持一下 谢谢!

介绍

QQ交流群:1065301527
HServer是一个基于Netty的一个高并发Webserver,它不仅仅是一个webserver,我们可以直接在这个基础上进行开发
它提供了相关的注解和一些方法,完全能够完成我们大大小小的项目。作为一名Java程序员写web程序spring是我们项目99%会用的。
spring的优点就不过多讲。Hserver是一个“tomcat”+“spring”的这样的小玩意。
它的qps比tomcat更快,这个是因为Hserver使用的Netty,注解比spring更简,这是因为,它还不够强大(滑稽,我会努力让它更智能点)
如果你是一个phper或者喜欢php,可以关注下 

黑小马工作室/HServer

最新中央仓库版本

<dependency>
    <groupId>top.hserver</groupId>
    <artifactId>HServer</artifactId>
    <version>2.9.8</version>
</dependency>


全部版本查询 https://repo1.maven.org/maven2/top/hserver/HServer/

压测说明

请查看 PM.md 查看说明

更新历史

请查看 CHANGELOG.md 了解近期更新情况。

文档地址

文档说明请查看 点我

文档源码地址 点我

Redis操作源码案例地址(Jedis) 点我

MYSQL操作源码案例地址(Neo) 点我

MYSQL操作源码案例地址(BeetlSQL) 点我

RPC操作源码案例地址(RPC) 点我

快速开始

1.文件结构框架架构说明

AB测试

2.注解认识

以下注解基本模拟Spring的功能


@Bean
将Bean对象加入IOC容器中比如
    //按默名字加入IOC容器
    @Bean
    class TestService{}
    //指定名字加入容器,装配的时候就只能通过名字装配了
    @Bean("testService")
    class Test{}
    
    
@Autowired
自动装配注解
    //按类型注入
    @Autowired
    private TestService testService;
    //按Bean名字注入
    @Autowired("testServer1")
    private TestService testService; 
    
       
@Controller
控制器注解,将控制器加入IOC容器中,类似Spring mvc
注解在类上面直接加上即可比如
    //Index控制器
    @Controller
    class IndexController{}
    
       
@GET,@POST,@RequestMapping
方法注解,在@Controller注解类类中使用,标注一个方法为GET或者POST方法,例如
    @GET("/index")
    public void index(){}  
    @POST("/index")
    public void index(){}
    
    //url规则匹配
    @GET("/url1/{url}")
    public String url(HttpRequest httpRequest){
        String url = httpRequest.query("url");
        System.out.println(url);
        return url;
    }

    @GET("/url/{url}")
    public String url(String url){
        return "匹配到的URL:"+url;
    }

    @POST("/a/{url}/bb")
    public String ab(String url){
        return "匹配到的URL:"+url;
    } 
     
    //2.9.4+以上支持
    @RequestMapping(value = "/PUT", method = RequestMethod.PUT)
    public JsonResult PUT() {
      return JsonResult.ok();
    }
    //2.9.4+以上支持
    @RequestMapping(value = "/get_post", method = {RequestMethod.POST,RequestMethod.GET})
    public JsonResult get_post() {
      return JsonResult.ok();
    }
    
    //2.9.4+以上支持
    //全类型
    @RequestMapping(value = "/all")
    public JsonResult all() {
      return JsonResult.ok();
    }

    
@Filter
拦截器注解,标注一个类为拦截器,和JavaEE的Filter类似
    @Filter(1)//1表示拦截优先级,越小越优先
    public class MyFilter1 implements FilterAdapter {}
    //需要实现FilterAdapter接口
    
    
@Hook
hook注解就是Aop
    @Hook(value = Test.class, method = "show")
    public class HookTest implements HookAdapter {}
    //value表示aop的类,method要hook的方法,必须实现HookAdapter
    
    
@Task
 定时任务
    @Task(name = "测试定时任务Cron", time ="*/5 * * * * ?")
    //标记在方法上,同时该类需要被@Bean 标记
    @Task(name = "测试定时任务1", time ="2000")
    public void timerTask() {}
    
    
@WebSocket
实现websocket通信
    @WebSocket("/ws")
    public class WebSocketTest implements WebSocketHandler {}
    //这样就可以完成基本的通信了
    
    
@Configuration
自定配置注解,需要配合@Bean注解一起使用,最后会把方法里面的返回的对象
存储到IOC容器中,同时可以通过Autowired注解注入
    @Configuration
    public class DataConfig {
    
        //自定义名字(用例:比如多数据源注入)
        @Bean("createUser")
        public User createUser(){
            User user = new User();
            user.setAge(999);
            user.setName("我是配置类自定义名字的数据");
            user.setSex("未知");
            return user;
        }
    
       //按类型存储 
        @Bean
        public User createUser1(){
            User user = new User();
            user.setAge(999);
            user.setName("我是配置类的默认数据");
            user.setSex("未知");
            return user;
        }
    
    }
    
    
@RpcService
标注一个Bean对象是一个rpc服务,也可以分配一个名字
    @Bean
    @RpcService
    public class RpcServiceTest {
        public String test(String name){
            return name+"我是RPC";
        }
    }  
    
    
@Resource
注入一个Rpc服务,也可以通过名字注入。详情,请看文档介绍   
    @Resource
    private RpcServiceTest rpcServiceTest;
    
    
@Sign("MD5")
@RequiresRoles("角色")
@RequiresPermissions(value = {"/权限1","/权限2"}, logical=Logical.OR)
该注解用于标注控制器里面的方法,方便自己实现sign签名算法,
角色检查,权限检查,实现token等,详情下面的对应接口。

3.完成Hello World项目

 #第一步pom依赖引入

<dependency>
    <groupId>top.hserver</groupId>
    <artifactId>HServer</artifactId>
    <version>最新版</version>
</dependency>

public class WebApp {
    public static void main(String[] args) {
        //运行官方例子,直接运行既可以了,默认自带了一些例子。
        HServerApplication.run(TestWebApp.class, 8888);
    }
}


#第二步搞一个主函数
public class WebApp {
    public static void main(String[] args) {
        HServerApplication.run(WebApp.class, 8888);
    }
}

#第三步同主函数建立一个包文件夹比如controller

@Controller
public class Hello {

    @GET("/hello")
    public Map index(HttpRequest request, String name) {
        Map<String, Object> res = new HashMap<>();
        res.put("code", 200);
        res.put("res", request.getRequestParams());
        res.put("msg", "Hello");
        return res;
    }
    
    /**
     * 模板测试
     * @param httpResponse
     */
    @GET("/template")
    public void template(HttpResponse httpResponse) {
        User user = new User();
        user.setAge(20);
        user.setName("xx");
        user.setSex("男");
        Map<String,Object> obj=new HashMap<>();
        obj.put("user",user);
//        httpResponse.sendTemplate("/admin/user/list.ftl", obj);
        httpResponse.sendTemplate("a.ftl", obj);
    }
}
#就这样你就完成了一个简单得get请求定义,更多例子,可以参考包top.test下面的例子

4.文件上传下载操作

      #File类型得
      @GET("/downFile")
      public void downFile(HttpRequest request, HttpResponse response) {
          response.setDownloadFile(new File("D:\\Java\\HServer\\README.md"));
      }
      #InputStream 类型得
      @GET("/downInputStream")
      public void downInputStream(HttpRequest request, HttpResponse response) throws Exception {
          File file = new File("D:\\Java\\HServer\\README.md");
          InputStream fileInputStream = new FileInputStream(file);
          response.setDownloadFile(fileInputStream,"README.md");
      }

5.Aop操作

    #必须实现HookAdapter的接口
    #同时被@Hook注解标注
    @Slf4j
    @Hook(value = Test.class, method = "show")
    public class HookTest implements HookAdapter {
    
        @Override
        public void before(Object[] objects) {
            log.info("aop.-前置拦截:" + objects[0]);
            objects[0]="666";
        }
    
        @Override
        public Object after(Object object) {
            return object + "aop-后置拦截";
        }
    }

6.Filter操作

    #必须实现FilterAdapter接口,同时被@Filter标注,数字越小,优先级越高,切不要重复
    @Slf4j
    @Filter(1)
    public class MyFilter2 implements FilterAdapter {
        @Override
        public void doFilter(FilterChain chain, Webkit webkit) {
            log.info("MyFilter->1");
            chain.doFilter(webkit);
        }
    }

7.定时任务操作

#需要被@Bean注解标注,可以通过TaskManager类进行定时任务的控制,动态添加和删除
@Bean
public class TaskTest {
    
    @Autowired
    private TestService testService;

    private boolean flag = true;

    public void dynamicAddTimer() {
        System.out.println("动态添加定时任务");
        TaskManager.addTask("测试任务2", "2000", TestTask.class,"666");
    }
    
    
    @Task(name = "测试定时任务1", time ="*/5 * * * * ?")
    public void timerTask() {
        System.out.println("测试定时任务,注入的对象调用结果:" + testService.testa());
        if (flag) {
            dynamicAddTimer();
            flag = false;
        }
    }

    @Task(name = "测试定时任务2", time = "2000")
    public void removeTask() {
        //干掉方法注解版本
        boolean task1 = TaskManager.removeTask("测试定时任务1");
        //干掉动态添加的
        boolean task2 = TaskManager.removeTask("测试任务2");
        //干掉自己
        boolean task3 = TaskManager.removeTask("测试定时任务2");
        //结果
        System.out.println("任务已经被干掉了 tash1=" + task1 + ",task2=" + task2 + ",task3=" + task3);
    }

}

//动态添加定时任务的实现类必须要实现一个TaskJob,样才能被TaskManager管理
//添加任务 TaskManager.addTask("测试任务2", "2000", TestTask.class,"666");
//删除任务  boolean is_success = TaskManager.removeTask("测试任务2");
public class TestTask implements TaskJob {

    @Override
    public void exec(Object... args) {
        String args_ = "";
        for (Object arg : args) {
            args_ += arg.toString();
        }
        System.out.println("测试定时器动态添加任务,参数是:" + args_);
    }
}

8.websocket操作

#需要被@WebSocket标注同时给一个连接地址,最后实现WebSocketHandler接口,
#Ws类定义了简单的发送方法,如果有其他的业务操作,可以获取ChannelHandlerContext,进行操作

@WebSocket("/ws")
public class WebSocketTest implements WebSocketHandler {

    @Autowired
    private TestService testService;

    @Override
    public void onConnect(Ws ws) {
        System.out.println("连接成功,分配的UID:" + ws.getUid());
    }

    @Override
    public void onMessage(Ws ws) {
        ws.send("666" + testService.testa() + ws.getUid());
        System.out.println("收到的消息,"+ws.getMessage()+",UID:" + ws.getUid());
    }

    @Override
    public void disConnect(Ws ws) {
        System.out.println("断开连接,UID:" + ws.getUid());
    }
}

9.自带监控操作

application.properties文件配置
    #开启访问统计
    statistics=true
    #统计规则:以逗号分割的正则表达式
    statisticalRules=/hel.*,/admin/.*
#StatisticsHandler操作
    #获取所有的IP地址
    StatisticsHandler.getIpMap()
    #请求队列(调用的URI,(发送大小,接收大小)宽带监视,耗时时间)
    StatisticsHandler.getLogRequestQue()
    #唯一IP请求的数量 uv
    StatisticsHandler.getUniqueIpCount()
    #请求总数   pv
    StatisticsHandler.getCount()
    #uri记录 被访问的记录()
    StatisticsHandler.getUriData()
#提示:
1,如果自己要做统计,完全可以自定义一个定时器,动态保存数据哦
2,StatisticsHandler,提供了一个remove方法,remove,用来清除,或者保存数据用,它会返回一个最新的数据同时清除自己
3,如果开启统计,请务必,执行Remove方法,不然,内存可能就会蹦

10.全局异常处理

类必须要被@Bean注解,同时实现GlobalException接口,
一个项目中最多只有一个GlobalException实现哦,可以没有.没有异常处理,同时又报错了,那么直接显示错误
@Bean
public class WebException implements GlobalException {

    @Override
    public void handler(Exception exception, Webkit webkit) {
        exception.printStackTrace();
        System.out.println(webkit.httpRequest.getUri() + "--->" + exception.getMessage());
        webkit.httpResponse.sendHtml("全局异常处理");
    }
}

11.服务器启动完成是执行的方法

 类必须要被@Bean注解,同时实现InitRunner接口,
 @Bean
 public class RunInit implements InitRunner {
 
     @Autowired
     private User user;
 
     @Override
     public void init(String[] args) {
         System.out.println("初始化方法:注入的User对象的名字是-->"+user.getName());
     }
 }

12.鉴权认证相关操作

//请使用相关注解对控制器的方法做标记,这样在执行到被注解标记的方法就会执行下面的相关方法
//  List<RouterPermission> routerPermissions = PermissionAdapter.getRouterPermissions();
// 通过上面的代码可以获取到所有标记的注解,他可以干嘛?
// 同步后台数据库里面的权限,后台管理面里面可以动态给角色分配权限。
// 自己做一个下拉选择列表,创建角色分配权限时,多选即可。

/**
 * 验证逻辑请自己实现哦
 */
@Bean
public class TestPermission implements PermissionAdapter {

    @Override
    public void requiresPermissions(RequiresPermissions requiresPermissions, Webkit webkit) {
        //这里你可以实现一套自己的权限检查算法逻辑,判断,
        //如果满足权限,不用其他操作,如果不满足权限,那么你可以通过,Webkit里面的方法直接输出相关内容
        //或者自定义一个异常类,在全局异常类做相关操作
        System.out.println(requiresPermissions.value()[0]);
    }

    @Override
    public void requiresRoles(RequiresRoles requiresRoles, Webkit webkit) {
        //这里你可以实现一套自己的角色检查算法逻辑,判断,
        //其他逻辑同上
        System.out.println(requiresRoles.value()[0]);
    }

    @Override
    public void sign(Sign sign, Webkit webkit) {
       //这里你可以实现一套自己的接口签名算法检查算法逻辑,判断,
       //其他逻辑同上
       Map<String, String> requestParams = webkit.httpRequest.getRequestParams();
       String sign1 = webkit.httpRequest.getHeader("sign");
       System.out.println(sign.value());
    }
}

13.RPC调用请看gitee的WIKi

14.HServer2.9.4+后添加APIDOC生成功能

详情请看WIKi

AB测试

15.技巧篇

1. Linux 内核版本大于 2.5.44,(目前云服务器都有了,没有的话自己升级内核)的Linux默认使用epoll
2.待更新
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.

简介

HServer是基于Netty做的一个超高性能WebServer同时支持RESTFul的轻量级,低入侵,高性能的框架,同时集成MVC等相关快速开发功能的高并发服务器,只需掌握几个简单的注解就像SpringBoot一样,就可快速开发出接口或者其他的应用,同时性能报表。 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/antonetwo/HServer.git
git@gitee.com:antonetwo/HServer.git
antonetwo
HServer
HServer-JAVA
master

搜索帮助

14c37bed 8189591 565d56ea 8189591