{"id":22140922,"url":"https://github.com/dapeng-soa/dapeng-sbt-plugin","last_synced_at":"2025-07-22T10:06:46.973Z","repository":{"id":107556778,"uuid":"116631638","full_name":"dapeng-soa/dapeng-sbt-plugin","owner":"dapeng-soa","description":"sbt plugin for dapeng-soa","archived":false,"fork":false,"pushed_at":"2024-04-23T03:09:07.000Z","size":71,"stargazers_count":1,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-24T11:18:40.401Z","etag":null,"topics":["dapeng","dapeng-soa","plugin","sbt"],"latest_commit_sha":null,"homepage":null,"language":"Scala","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/dapeng-soa.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,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2018-01-08T04:56:57.000Z","updated_at":"2020-02-19T03:59:50.000Z","dependencies_parsed_at":"2023-04-13T15:22:42.947Z","dependency_job_id":null,"html_url":"https://github.com/dapeng-soa/dapeng-sbt-plugin","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/dapeng-soa/dapeng-sbt-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dapeng-soa%2Fdapeng-sbt-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dapeng-soa%2Fdapeng-sbt-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dapeng-soa%2Fdapeng-sbt-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dapeng-soa%2Fdapeng-sbt-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dapeng-soa","download_url":"https://codeload.github.com/dapeng-soa/dapeng-sbt-plugin/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dapeng-soa%2Fdapeng-sbt-plugin/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266473036,"owners_count":23934475,"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-07-22T02:00:09.085Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"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":["dapeng","dapeng-soa","plugin","sbt"],"created_at":"2024-12-01T21:08:37.980Z","updated_at":"2025-07-22T10:06:46.946Z","avatar_url":"https://github.com/dapeng-soa.png","language":"Scala","funding_links":[],"categories":[],"sub_categories":[],"readme":"# sbt-dapeng 插件使用指南\n\n目录：\n\u003e 1. sbt-dapeng插件能干什么\n\u003e 2. sbt-dapeng插件怎么用\n\u003e   2.1 使用sbt-dapeng快速启动测试hello项目\n\u003e   2.2 自定义自己的项目\n\u003e 3. sbt-dapeng提供的指令详细说明\n\u003e   3.1 ```sbt new```\n\u003e   3.2 ```sbt docker```\n\u003e   3.3 ```compile``` (内置了thrift生成功能)\n\u003e   3.4 ```sbt runContainer```\n\u003e   3.5 ```sbt test```\n\n### sbt-dapeng插件能干什么\n    sbt-dapeng 插件提供了以下几个功能\n\u003e 1. 一个指令(sbt new xxx)：即可生成一个服务代码\n\u003e 2. 一个指令(sbt compie)：即可基于thrift文件生成所需的接口以及实体对象\n\u003e 3. 一个指令(sbt docker)：即可构建docker镜像\n\u003e 4. 一个指令(sbt runContainer)：即可运行服务项目\n\u003e 5. 一个指令(sbt test)： 即可测试服务接口\n\n### sbt-dapeng 插件怎么用\n#### 测试环境需求（后续会升级到正式版）:\n1. 确保java 的版本为 1.8\n2. 确保scala的版本为 2.12.2 或以上\n3. 确保sbt 的版本为  1.0.0 或以上\n4. 下载isuwang-soa项目: 在根目录执行 ```mvn clean install```\n5. 下载sbt-dapeng项目: 在master 分支, 执行 ```sbt publishLocal```\nps: 最好安装一下 sbt 代理，能加速sbt 的下载依赖以及构建:  ```https://github.com/Centaur/repox```\n\n#### 1. 使用sbt-dapeng快速启动测试hello项目\n下面我们来看一下如何使用sbt-dapeng来快速测试Hello项目\n\n##### 1.1.  创建项目\n首先，cd到你要创建项目的目录，(以~/dev/github 为例)\n然后执行 ```sbt new isuwang/dapeng-soa.g8``` , 会出现以下画面, 填入对应参数即可创建HelloWorld拉\n```sh\n\u003e sbt new isuwang/dapeng-soa.g8\n[info] Loading settings from idea.sbt ...\n[info] Loading global plugins from /yourHomePath/.sbt/1.0/plugins\n[info] Set current project to github (in build file:/yourProjectPath/)\n\nthis is a template to genreate dapeng api service\n\nname [api]: bbq     # yourProjectName\nversion [\"0.1-SNAPSHOT\"]:  # yourProjectVersion\nscalaVersion [\"2.12.2\"]:   # yourScalaVersion\norganization [com.isuwang]: # your project GroupId\nresources [resources]:      # defaultValue, no need to modify\napi [HelloWorld-api]:           # defaultTemplateValue, no need to modify\nservice [HelloWorld-service]:  # defaultTemplateValue, no need to modify\njava [java]:                    # defaultTemplateValue, no need to modify\nscala [scala]:                  # defaultTemplateValue, no need to modify\ndocker [docker]:\nservicePackage [com.isuwang.soa]: # default root package modify\n\nTemplate applied in ./helloworld\n```\n\n\u003csmall\u003e`isuwang/dapeng-soa.g8` 是一个基于giter8 创建的模版项目，开发人员无需关心，只需要知道你创建的项目是基于该模版创建的即可。如果想进一步了解，请查看github：[isuwang/dapeng-soa.g8](https://github.com/isuwang/dapeng-soa.g8)\ndapeng-soa.g8 内置了一个样例服务（HelloService）, 开发可以参考\u003c/small\u003e\n\n##### 1.2. 编译创建好的模板项目\ncd到项目根目录 ```cd helloWorld``` 执行 ```sbt compile```\n```sh\n\u003e sbt compile\n[info] Loading settings from idea.sbt ...\n[info] Loading global plugins from /Users/jackliang/.sbt/1.0/plugins\n[info] Loading settings from build.sbt,plugins.sbt ...\n[info] Loading project definition from /Users/jackliang/dev/github/bbq/project\n[info] Loading settings from build.sbt ...\n[info] Set current project to sbt-idlc (in build file:/Users/jackliang/dev/github/bbq/)\n[info] Executing in batch mode. For better performance use sbt 's  shell\nscrooge:-gen java -all -in /Users/jackliang/dev/github/bbq/bbq-api/src/main/resources/thrifts -out /Users/jackliang/dev/github/bbq/bbq-api/src/main\nscrooge:-gen scala -all -in /Users/jackliang/dev/github/bbq/bbq-api/src/main/resources/thrifts -out /Users/jackliang/dev/github/bbq/bbq-api/src/main\n[success] Total time: 1 s, completed 2017-11-11 16:38:46\n```\n\n##### 1.3 构建项目镜像\n执行 ```sbt docker```, 我们会得到如下镜像:\ndocker.oa.isuwang.com:5000/product/bbq_service:latest\n```sh\n\u003e sbt docker\n[info] Step 1/7 : FROM docker.oa.isuwang.com:5000/system/dapeng-container:1.2.1\n[info]  ---\u003e 73df0043a78c\n[info] Step 2/7 : RUN mkdir -p /dapeng-container\n[info]  ---\u003e Using cache\n[info]  ---\u003e ee2e23a17ebd\n[info] Step 3/7 : COPY 0/bbq_service-assembly-0.1-SNAPSHOT.jar /dapeng-container/apps\n[info]  ---\u003e b99e8cd2bbc5\n[info] Removing intermediate container 1efd6666d8d9\n[info] Step 4/7 : COPY 1/startup.sh /dapeng-container/bin/\n[info]  ---\u003e 911fa73a3791\n[info] Removing intermediate container c1b0bb2efdb4\n[info] Step 5/7 : RUN chmod +x /dapeng-container/bin/startup.sh\n[info]  ---\u003e Running in bbc571506fdd\n[info]  ---\u003e 7823dab2c923\n[info] Removing intermediate container bbc571506fdd\n[info] Step 6/7 : WORKDIR /dapeng-container/bin\n[info]  ---\u003e 2481076bf248\n[info] Removing intermediate container 83b73c25edbf\n[info] Step 7/7 : CMD /bin/sh -c /dapeng-container/bin/startup.sh \u0026\u0026 tail -F /dapeng-container/bin/startup.sh\n[info]  ---\u003e Running in 65fba4c6e7ca\n[info]  ---\u003e 828797c3ec01\n[info] Removing intermediate container 65fba4c6e7ca\n[info] Successfully built 828797c3ec01\n[info] Tagging image 828797c3ec01 with name: docker.oa.isuwang.com:5000/product/bbq_service:latest\n```\n1.4 启动镜像\n常规的启动镜像是配置 dc-all.yml文件，然后配置dc-local.yml巴拉巴拉..., 现在为了快速启动镜像，提供一个docker run 指令来启动镜像, 如果想快速测试可以使用该方法: (记得修改一下你的Ip，文件路径,端口)\n\n```sh\ndocker run -p yourIp:8999:8999 --name=\"bbq\" -e soa_container_port=8999 -e soa_container_ip=yourIp -e soa_service_port=8999 -e soa_service_ip=yourIp -e soa_zookeeper_host=yourIp:2181 -e LANG=zh_CN.UTF-8 --env-file /yourWorkPath/kscompose/.envs/application.env --add-host soa_zookeeper:yourIp  --add-host db-master:yourIp docker.oa.isuwang.com:5000/product/bbq_service:latest\n```\n启动完镜像，我们再启动一下zookeeper, mysql\n然后我们 ```docker ps ``` 一下, 可以看到bbq已经启动了\n``` sh\nPORTS                          NAMES\nyourIp:8999-\u003e8999/tcp          bbq\n0.0.0.0:2181-\u003e2181/tcp         zookeeper\nyourIp:3306-\u003e3306/tcp          mysql\n```\n\n\n1.5 测试\n条件: 需要服务端项目执行一下 ```sbt publishLocal```\n    (ps: 目的是为了拿到服务api的版本)\n\n新建一个项目，\n添加依赖: (以前面创建的 hello项目为例, 添加hello-api 以及客户端调用所需的dapeng包)\n```java\n\u003cdependencies\u003e\n        \u003cdependency\u003e\n            \u003cgroupId\u003ecom.isuwang\u003c/groupId\u003e\n            \u003cartifactId\u003ehello-api_2.12\u003c/artifactId\u003e\n            \u003cversion\u003e0.1-SNAPSHOT\u003c/version\u003e\n        \u003c/dependency\u003e\n        \u003cdependency\u003e\n            \u003cgroupId\u003ecom.isuwang\u003c/groupId\u003e\n            \u003cartifactId\u003edapeng-remoting-api\u003c/artifactId\u003e\n            \u003cversion\u003e1.2.1\u003c/version\u003e\n        \u003c/dependency\u003e\n        \u003cdependency\u003e\n            \u003cgroupId\u003ecom.isuwang\u003c/groupId\u003e\n            \u003cartifactId\u003edapeng-core\u003c/artifactId\u003e\n            \u003cversion\u003e1.2.1\u003c/version\u003e\n        \u003c/dependency\u003e\n        \u003cdependency\u003e\n            \u003cgroupId\u003ecom.isuwang\u003c/groupId\u003e\n            \u003cartifactId\u003edapeng-remoting-netty\u003c/artifactId\u003e\n            \u003cversion\u003e1.2.1\u003c/version\u003e\n        \u003c/dependency\u003e\n        \u003cdependency\u003e\n            \u003cgroupId\u003ecom.isuwang\u003c/groupId\u003e\n            \u003cartifactId\u003edapeng-registry-zookeeper\u003c/artifactId\u003e\n            \u003cversion\u003e1.2.1\u003c/version\u003e\n        \u003c/dependency\u003e\n\n        \u003cdependency\u003e\n            \u003cgroupId\u003ecom.isuwang\u003c/groupId\u003e\n            \u003cartifactId\u003edapeng-spring\u003c/artifactId\u003e\n            \u003cversion\u003e1.2.1\u003c/version\u003e\n            \u003cexclusions\u003e\n                \u003cexclusion\u003e\n                    \u003cgroupId\u003eorg.springframework\u003c/groupId\u003e\n                    \u003cartifactId\u003espring-context\u003c/artifactId\u003e\n                \u003c/exclusion\u003e\n            \u003c/exclusions\u003e\n        \u003c/dependency\u003e\n\n    \u003c/dependencies\u003e\n```\n写个main方法\n```scala\nobject TestClient2 {\n\n  def main(args: Array[String]): Unit = {\n    val hello = HelloServiceClient.sayHello(\"test\")\n    println(s\" hello : ${hello}\")\n  }\n}\n```\n就可以看到正常返回了. 至此整个 开发 -\u003e 编译 -\u003e 启动 -\u003e 测试流程结束\n\n1.5.1 测试模版\n我们还提供了一个客户端测试模版. 意不意外？惊不惊喜？\n只需要执行 ```sbt new isuwang/dapeng-soa-client.g8``` 就能把项目下下来，然后执行```ClientTest``` 的 ```main``` 方法 就能看到测试结果了\n\u003csmall\u003e（ps： 同上需要注意build.sbt的api依赖版本与你 publishLocal 后生成的api版本要一致）\u003c/small\u003e","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdapeng-soa%2Fdapeng-sbt-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdapeng-soa%2Fdapeng-sbt-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdapeng-soa%2Fdapeng-sbt-plugin/lists"}