{"id":31295758,"url":"https://github.com/wwjwell/microboot","last_synced_at":"2025-09-24T20:06:05.283Z","repository":{"id":57730075,"uuid":"86895572","full_name":"wwjwell/microboot","owner":"wwjwell","description":"A high performance HTTP restful server base on netty, A netty http server, support HTTP2.0","archived":false,"fork":false,"pushed_at":"2017-11-07T08:39:50.000Z","size":1121,"stargazers_count":37,"open_issues_count":0,"forks_count":30,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-07-22T16:46:17.235Z","etag":null,"topics":["http2","mvc","netty","restful","server","springboot"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wwjwell.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-04-01T07:56:33.000Z","updated_at":"2025-05-23T01:36:01.000Z","dependencies_parsed_at":"2022-09-07T20:30:35.646Z","dependency_job_id":null,"html_url":"https://github.com/wwjwell/microboot","commit_stats":null,"previous_names":["wwjwell/micrboot"],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/wwjwell/microboot","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wwjwell%2Fmicroboot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wwjwell%2Fmicroboot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wwjwell%2Fmicroboot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wwjwell%2Fmicroboot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wwjwell","download_url":"https://codeload.github.com/wwjwell/microboot/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wwjwell%2Fmicroboot/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":276810922,"owners_count":25708884,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-24T02:00:09.776Z","response_time":97,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["http2","mvc","netty","restful","server","springboot"],"created_at":"2025-09-24T20:06:01.307Z","updated_at":"2025-09-24T20:06:05.277Z","avatar_url":"https://github.com/wwjwell.png","language":"Java","funding_links":[],"categories":["Web服务器"],"sub_categories":["微服务框架"],"readme":"# microboot 是什么，能做什么？\n### microboot是什么\nmicroboot 是基于Netty 开发的一个Http服务框架，自身提供http server功能，jar包方式启动，使用方式与架构与SpringMVC极其相似，microboot没有遵循java web规范，非常轻量级，并且高性能。\n### microboot能做什么\nmicroboot天生是为了后端纯接口服务做得框架，具有开发、部署简单，高性能并且稳定，支持所有http请求方式，支持多视图，并且可以根据自己的要求自定义ViewResolver返回自己想要的结果，目前服务只String、JSONView 两种返回。\n\n# microboot 优缺点\n### 优点\n- 支持HTTP2.0\n- 超级轻量级的框架\n- 性能优越，稳定，尤其对于非常暴增的流量，能够稳定支撑\n- 使用简单，上手快，只要学过springMVC 基本没有任何学习瓶颈\n- 非常干净，不占用多余端口，非特殊情况不需要对他的性能调优\n- 开发简单、启动快，jar包启动\n- 支持一机多应用，节省开发、测试服务器资源\n- 许多后端接口使用的特性支持，如多接口合并\n- 等等\n### 缺点\n- 由于不支持java web规范，所以不能支持jsp（绝对不会支持），目前还不支持静态资源(作者还没写，以后会支持)，freemark等模板语言不支持(作者还没有写，可以自己处理直接返回String)\n- 不是标准，非权威\n\n# microboot设计思想\nmicroboot设计思想源于springMVC，摒弃J2EE繁杂的规范，更加纯粹的进行HTTP编程，不依赖于任何第三方容器，运用高性能的Netty框架做server ，以及netty的线程模型来处理业务。一旦你使用了microboot，或许你再也不想用tomcat做你的容器了。\n    TIPS:下图是增加HTTP2.0功能之前的架构，HttpSimpleChannelHandler变更为多个Handler，主要是为了支持Http2.0，后面架构不变\n- ![image](https://github.com/wwjwell/microboot/raw/master/docs/microboot.png)\n\n# microboot依赖情况\nmicroboot强依赖于netty 、jackson、slf4j、spring，需要你在项目中引入这4个jar\n\n# microboot怎么使用\n### maven配置\n```\n    \u003c!-- 依赖 --\u003e\n    \u003cdependency\u003e\n        \u003cgroupId\u003eorg.springframework\u003c/groupId\u003e\n        \u003cartifactId\u003espring-context\u003c/artifactId\u003e\n    \u003c/dependency\u003e\n    \u003cdependency\u003e\n        \u003cgroupId\u003eio.netty\u003c/groupId\u003e\n        \u003cartifactId\u003enetty-all\u003c/artifactId\u003e\n    \u003c/dependency\u003e\n    \u003cdependency\u003e\n        \u003cgroupId\u003ecom.fasterxml.jackson.core\u003c/groupId\u003e\n        \u003cartifactId\u003ejackson-databind\u003c/artifactId\u003e\n   \u003c/dependency\u003e\n   \u003cdependency\u003e\n       \u003cgroupId\u003eorg.slf4j\u003c/groupId\u003e\n        \u003cartifactId\u003eslf4j-api\u003c/artifactId\u003e\n   \u003c/dependency\u003e\n```\n```\n    \u003cdependency\u003e\n      \u003cgroupId\u003ecom.github.wwjwell\u003c/groupId\u003e\n      \u003cartifactId\u003emicroboot\u003c/artifactId\u003e\n      \u003cversion\u003e2.0.0\u003c/version\u003e\n    \u003c/dependency\u003e\n```\n### spring 配置 \n* 可参照 microboot-demo/src/main/resources/api.xml\n``` \n    \u003ccontext:component-scan base-package=\"com.github.wwjwell.microboot.demo.**\"\u003e\n        \u003c!-- 扫描ApiCommand注解 --\u003e\n        \u003ccontext:include-filter type=\"annotation\" expression=\"com.github.wwjwell.microboot.mvc.annotation.ApiCommand\"/\u003e\n    \u003c/context:component-scan\u003e\n    \u003c!--追求高性能，需要单独设置适合自己业务逻辑的线程池--\u003e\n    \u003cbean id=\"threadPoolTaskExecutor\" class=\"org.springframework.scheduling.concurrent.ThreadPoolTaskExecutor\"\u003e\n        \u003cproperty name=\"corePoolSize\" value=\"8\" /\u003e\n        \u003cproperty name=\"threadNamePrefix\" value=\"microboot-task-\"/\u003e\n        \u003cproperty name=\"waitForTasksToCompleteOnShutdown\" value=\"true\" /\u003e\n    \u003c/bean\u003e\n    \u003cbean id=\"serverConfig\" class=\"com.github.wwjwell.microboot.ServerConfig\"\u003e\n        \u003cproperty name=\"port\" value=\"8080\"/\u003e\n        \u003cproperty name=\"maxLength\" value=\"65536\"/\u003e \u003c!-- 传输的报文过大，会报错 --\u003e\n        \u003cproperty name=\"maxKeepAliveRequests\" value=\"1000\"/\u003e  \u003c!-- keep-alive 最大请求数 --\u003e\n        \u003cproperty name=\"executor\" ref=\"threadPoolTaskExecutor\"/\u003e \u003c!--追求高性能，需要单独设置适合自己业务逻辑的线程池--\u003e\n        \u003c!-- 打开调试开关 ，生产环境请关闭 --\u003e\n        \u003cproperty name=\"openConnectCostLogger\" value=\"true\"/\u003e\n        \u003cproperty name=\"openMetricsLogger\" value=\"true\"/\u003e\n    \u003c/bean\u003e\n    \u003c!-- config server --\u003e\n    \u003cbean name=\"server\" class=\"com.github.wwjwell.microboot.Server\"\u003e\n        \u003cproperty name=\"serverConfig\" ref=\"serverConfig\"/\u003e \u003c!-- set port=8080 --\u003e\n    \u003c/bean\u003e\n```\n### SSL 默认开启HTTP2.0\n```\n       \u003cbean id=\"serverConfig\" class=\"com.github.wwjwell.microboot.ServerConfig\"\u003e\n        \u003cproperty name=\"port\" value=\"8080\"/\u003e\n        \u003cproperty name=\"maxLength\" value=\"65536\"/\u003e \u003c!-- 传输的报文过大，会报错 --\u003e\n        \u003cproperty name=\"maxKeepAliveRequests\" value=\"1000\"/\u003e  \u003c!-- keep-alive 最大请求数 --\u003e\n        \u003cproperty name=\"executor\" ref=\"threadPoolTaskExecutor\"/\u003e \u003c!--追求高性能，需要单独设置适合自己业务逻辑的线程池--\u003e\n        \u003c!-- 打开调试开关 ，生产环境请关闭 --\u003e\n        \u003cproperty name=\"openConnectCostLogger\" value=\"true\"/\u003e\n        \u003cproperty name=\"openMetricsLogger\" value=\"true\"/\u003e\n\n        \u003c!-- 配置SSL 默认支持http2.0 这4项 --\u003e\n        \u003cproperty name=\"openSSL\" value=\"true\"/\u003e\n        \u003c!-- 证书 --\u003e\n        \u003cproperty name=\"keyCertChainFilePath\" value=\"/Users/wwj/work/server.crt\"/\u003e\n        \u003c!-- 私钥pem格式 --\u003e\n        \u003cproperty name=\"keyFilePath\" value=\"/Users/wwj/work/server_key.pem\"/\u003e\n        \u003c!-- 私钥密码 --\u003e\n        \u003cproperty name=\"keyPassword\" value=\"123456\"/\u003e\n    \u003c/bean\u003e\n\n```\n\n### 输入helloworld\n```\n    @ApiCommand\n    public class HelloWorldCommand{\n        @ApiMethod(\"/hello/world\")\n        public String helloWorld(){\n            return \"Hello World\";\n        }    \n    }\n    \n    curl http://localhost:8080/hello/world   \n    #输出 Hello World\n```\n### 输出Json \n```\n    @ApiCommand(\"json\")\n    public class JsonCommand{\n        @ApiMethod(\"/test\",httpMethod = ApiMethod.HttpMethod.POS)\n        public ModelAndView test(@ApiParam(\"name\")String name,@ApiParam(\"id\")int id){\n            ModelAndView mv = new ModelAndView(\"jsonView\");\n            Map\u003cString, Object\u003e res = new HashMap\u003cString, Object\u003e();\n            res.put(\"id\",id);\n            res.put(\"name\", name);\n            mv.setResult(mv);\n            return mv;\n        }    \n    }\n    \n    curl -d 'name=tomcat\u0026id=100' 'http://localhost:8080/json/test'   \n    #输出 {\"name\":\"tomcat\",\"id\":100}\n```\n### 更多例子和用法\n请看microboot-demo\n\n# 拦截器\n* 类springMVC拦截器\n  增加拦截器，需要在spring配置文件中显示调用\n\n```\n  \u003cbean class=\"com.github.wwjwell.microboot.demo.interceptor.TestInterceptor\"\u003e  \n      \u003cproperty name=\"order\" value=\"1\"/\u003e\n  \u003c/bean\u003e\n    \n    public class TestInterceptor extends AbstractApiInterceptor {\n        int order ; //拦截器执行顺序\n        //分发之前，甚至可以更改最终invoke的接口\n        @Override\n        public boolean preDispatch(HttpContextRequest request, HttpContextResponse response) {\n            System.out.println(\"TestInterceptor preDispatch url=\"+request.getRequestUrl());\n            return super.preDispatch(request, response);\n        }\n        \n        //执行invoke方法之前，可以更改，增加删除参数值\n        @Override\n        public boolean postHandler(ApiCommandMapping mapping, HttpContextRequest request, HttpContextResponse response) {\n            System.out.println(\"TestInterceptor postHandler url=\"+request.getRequestUrl());\n            return super.postHandler(mapping, request, response);\n        }\n        \n        //执行invoke方法之后，可以修改返回值\n        @Override\n        public void afterHandle(ApiCommandMapping mapping, Object modelView, HttpContextRequest request, HttpContextResponse response, Throwable throwable) {\n            System.out.println(\"TestInterceptor afterHandle url=\"+request.getRequestUrl());\n            super.afterHandle(mapping, modelView, request, response, throwable);\n        }\n    }\n```\n\n# 接口合并\n    暴露内部doProcess方法，可以操控任意一个或多个ApiMethod的返回。可以比较轻易的获取改方法返回，通常用于接口合并，减少请求交互次数\n    BatchCommandTest例子：APP需要请求/t1,/t2 接口，可以直接请求/batch，batch根据约定可以组装t1,t2的返回值\n* 设置spring配置文件 需要增加一个设置，获取apiDispatcher内部处理类，调用doProcess方法\n```\n    \u003cbean class=\"com.github.wwjwell.microboot.mvc.ApiDispatcher\"/\u003e\n```\n\n具体用法参考microboot-demo的 com.github.wwjwell.microboot.demo.command.BatchCommndTest类\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwwjwell%2Fmicroboot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwwjwell%2Fmicroboot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwwjwell%2Fmicroboot/lists"}