{"id":21081321,"url":"https://github.com/seepine/wrap-spring-boot-starter","last_synced_at":"2025-05-16T08:32:48.455Z","repository":{"id":57727045,"uuid":"432657243","full_name":"seepine/wrap-spring-boot-starter","owner":"seepine","description":"easy wrap for springboot ","archived":false,"fork":false,"pushed_at":"2023-06-15T07:02:55.000Z","size":144,"stargazers_count":4,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-03T22:51:14.755Z","etag":null,"topics":["spring-boot","wrap"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/seepine.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-11-28T08:22:41.000Z","updated_at":"2023-10-02T13:13:53.000Z","dependencies_parsed_at":"2024-11-19T05:50:17.122Z","dependency_job_id":null,"html_url":"https://github.com/seepine/wrap-spring-boot-starter","commit_stats":null,"previous_names":["seepine/spring-boot-starter-wrap"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seepine%2Fwrap-spring-boot-starter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seepine%2Fwrap-spring-boot-starter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seepine%2Fwrap-spring-boot-starter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/seepine%2Fwrap-spring-boot-starter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/seepine","download_url":"https://codeload.github.com/seepine/wrap-spring-boot-starter/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254496368,"owners_count":22080698,"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":["spring-boot","wrap"],"created_at":"2024-11-19T20:08:17.184Z","updated_at":"2025-05-16T08:32:43.438Z","avatar_url":"https://github.com/seepine.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# spring-boot-starter-wrap\r\n\r\neasy wrap for springboot\r\n\r\n- 依赖引入后，所有接口返回都会被封装成{code:0,data:{},msg:''}的形式\r\n- 当接口抛出WrapException，将会封装成{code:1,msg:''}\r\n- 当接口不想被封装时，只需要在方法或类上加@NotWrap注解即可\r\n\r\n## 集成\r\n\r\n### 引入依赖\r\n\r\n- Latest\r\n  Version: [![Maven Central](https://img.shields.io/maven-central/v/com.seepine/wrap-spring-boot-starter.svg)](https://search.maven.org/search?q=g:com.seepine%20a:wrap-spring-boot-starter)\r\n- Maven:\r\n\r\n```xml\r\n\r\n\u003cdependency\u003e\r\n    \u003cgroupId\u003ecom.seepine\u003c/groupId\u003e\r\n    \u003cartifactId\u003ewrap-spring-boot-starter\u003c/artifactId\u003e\r\n    \u003cversion\u003e${Latest-Version}\u003c/version\u003e\r\n\u003c/dependency\u003e\r\n```\r\n\r\n### 指定拦截包路径\r\n\r\n不指定则默认拦截所有。若有集成Swagger，必须指定，否则可能导致`Unable to infer base url.`\r\n\r\n```yaml\r\nwrap:\r\n  #多个路径逗号隔开 com.example.controller1,com.example.controller2\r\n  scan-packages: com.example.controller\r\n```\r\n\r\n## 例子\r\n\r\n### 1 返回字符串类型\r\n\r\ncontroller:\r\n\r\n```java\r\nclass Controller {\r\n    @RequestMapping(\"hello\")\r\n    public String hello() {\r\n        return \"hello world\";\r\n    }\r\n}\r\n```\r\n\r\nresponse:\r\n`需要注意，个别请求库(例如flutter的dio)接收到的可能是jsonString，需要转为对象JSON.parse(jsonString)`\r\n\r\n```json\r\n{\r\n  \"code\": 0,\r\n  \"data\": \"hello world\"\r\n}\r\n```\r\n\r\n### 2 返回对象类型\r\n\r\nentity:\r\n\r\n```java\r\nclass User {\r\n    Long id;\r\n    String fullName;\r\n    Integer age;\r\n\r\n    public User(Long id, String fullName, Integer age) {\r\n        this.id = id;\r\n        this.fullName = fullName;\r\n        this.age = age;\r\n    }\r\n}\r\n```\r\n\r\ncontroller:\r\n\r\n```java\r\nclass Controller {\r\n    @RequestMapping(\"user\")\r\n    public User user() {\r\n        return new User(1L, \"jackson\", 24);\r\n    }\r\n}\r\n```\r\n\r\nresponse:\r\n\r\n```json\r\n{\r\n  \"code\": 0,\r\n  \"data\": {\r\n    \"id\": 1,\r\n    \"fullName\": \"jackson\",\r\n    \"age\": 24\r\n  }\r\n}\r\n```\r\n\r\n### 3 带错误信息的异常处理\r\n\r\ncontroller:\r\n\r\n```java\r\nclass Controller {\r\n    @RequestMapping(\"sum\")\r\n    public String sum() {\r\n        // ...\r\n        throw new WrapException(\"错误信息\");\r\n    }\r\n}\r\n```\r\n\r\nresponse:\r\n\r\n```json\r\n{\r\n  \"code\": 1,\r\n  \"msg\": \"错误信息\"\r\n}\r\n```\r\n\r\n### 4 带数据的异常处理\r\n\r\ncontroller:\r\n\r\n```java\r\nclass Controller {\r\n    @RequestMapping(\"del\")\r\n    public String del() {\r\n        //...\r\n        throw new WrapException(new Object(), \"错误信息2\");\r\n    }\r\n}\r\n```\r\n\r\nresponse:\r\n\r\n```json\r\n{\r\n  \"code\": -1,\r\n  \"data\": {\r\n    //..\r\n  },\r\n  \"msg\": \"错误信息2\"\r\n}\r\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fseepine%2Fwrap-spring-boot-starter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fseepine%2Fwrap-spring-boot-starter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fseepine%2Fwrap-spring-boot-starter/lists"}