{"id":15044099,"url":"https://github.com/vzardlloo/crab","last_synced_at":"2025-04-10T00:42:41.776Z","repository":{"id":57735155,"uuid":"117053864","full_name":"vzardlloo/crab","owner":"vzardlloo","description":"🦀 a simple web server","archived":false,"fork":false,"pushed_at":"2021-04-02T08:20:27.000Z","size":119,"stargazers_count":18,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-10T00:42:38.064Z","etag":null,"topics":["http-server","java-8","server","web","web-server"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vzardlloo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-01-11T05:21:12.000Z","updated_at":"2021-09-30T08:13:43.000Z","dependencies_parsed_at":"2022-09-08T11:50:21.917Z","dependency_job_id":null,"html_url":"https://github.com/vzardlloo/crab","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vzardlloo%2Fcrab","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vzardlloo%2Fcrab/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vzardlloo%2Fcrab/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vzardlloo%2Fcrab/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vzardlloo","download_url":"https://codeload.github.com/vzardlloo/crab/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248137998,"owners_count":21053775,"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","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":["http-server","java-8","server","web","web-server"],"created_at":"2024-09-24T20:50:04.776Z","updated_at":"2025-04-10T00:42:41.751Z","avatar_url":"https://github.com/vzardlloo.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🦀 Crab\n\nCrab是一款简单的、轻量级的、采用Java开发的http服务器,主要用到了NIO与多线程技术\n\n# 特点\n+ 简单小巧，便于帮助理解http服务器的基本工作原理\n+ 配置使用简单\n+ 依赖很少,仅依赖了`lombok`来简化代码书写，和`dom4j`来操作配置文件\n\n注：**在运行源码时要安装`lombok`插件,关于[lombok](https://projectlombok.org/)**\n\n# 进展\n* [x] 基本功能完成\n* [ ] 开发更多功能\n# 使用\n首先添加依赖：\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003eio.github.vzardlloo\u003c/groupId\u003e\n    \u003cartifactId\u003ecrab\u003c/artifactId\u003e\n    \u003cversion\u003e${latest version}\u003c/version\u003e\n\u003c/dependency\u003e\n```\nor\n```\ncompile 'io.github.vzardlloo:crab:${latest version}'\n```\nCrab的使用非常简单：\n\n首先在项目的`resource`目录下创建`crab.xml`,内容为\n```\n\u003ccrabConfig\u003e\n    \u003citem key=\"port\" value=\"端口号\"/\u003e\n    \u003citem key=\"workspace\" value=\"工作空间路径\"/\u003e\n\u003c/crabConfig\u003e\n```\n然后开始使用crab,代码非常简单直观：\n```\npublic static void main(String[] args) throws IOException {\n        new Crab().start();\n    }\n```\n即可启用crab。\n以上是默认的使用方式，你还可以对crab进行一些自定义，比如想自定义配置文件的存放位置,你可以这样\n\n````\npublic static void main(String[] args) throws IOException {\n        new Crab().setConfigFilePath(\"xxxxx\").start();\n    }\n````\n或者干脆不想使用配置文件也是可以的\n```\n public static void main(String[] args) throws IOException {\n        new Crab(端口号)\n                .addHandler(new AssetHandler(\"工作空间路径\"))\n                .start();\n    }\n\n```\n以上的端口号需要确保没有被占用，至于工作空间可以任意指定，不需要保证你的计算机上已经存在该路径，因为Crab会自动根据配置创建工作空间，并进行一些简单的初始化操作。\n\n一切工作完成之后,Crab在本地启动后，在浏览器地址栏输入：`localhost：端口号`，会看到Crab的欢迎页面：\n![](http://oo3aq3ac8.bkt.clouddn.com/crab.png)\n这时你就可以把你的`html`页面等放入你的Crab工作空间里，然后通过浏览器便可访问到它们。\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvzardlloo%2Fcrab","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvzardlloo%2Fcrab","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvzardlloo%2Fcrab/lists"}