{"id":13525187,"url":"https://github.com/Senssic/sc-whorl","last_synced_at":"2025-04-01T04:31:25.817Z","repository":{"id":37339135,"uuid":"228976248","full_name":"senssic/sc-whorl","owner":"senssic","description":"springboot2.x 脚手架 日志，缓存，分布式锁，分页，权限认证，等开箱即用","archived":false,"fork":false,"pushed_at":"2024-08-14T08:36:24.000Z","size":92,"stargazers_count":22,"open_issues_count":0,"forks_count":13,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-08-14T09:55:35.485Z","etag":null,"topics":[],"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/senssic.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":"2019-12-19T04:40:46.000Z","updated_at":"2023-12-11T11:51:49.000Z","dependencies_parsed_at":"2024-08-14T10:05:46.123Z","dependency_job_id":null,"html_url":"https://github.com/senssic/sc-whorl","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/senssic%2Fsc-whorl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/senssic%2Fsc-whorl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/senssic%2Fsc-whorl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/senssic%2Fsc-whorl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/senssic","download_url":"https://codeload.github.com/senssic/sc-whorl/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222698222,"owners_count":17024879,"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":[],"created_at":"2024-08-01T06:01:16.676Z","updated_at":"2024-11-02T09:30:53.242Z","avatar_url":"https://github.com/senssic.png","language":"Java","funding_links":[],"categories":["开源"],"sub_categories":[],"readme":"# sc-whorl\n\n## 项目简介\n\n[![License](https://img.shields.io/github/license/Senssic/sc-whorl.svg?style=flat)](https://github.com/Senssic/sc-whorl/blob/master/LICENSE)\n[![JDK 1.8+](https://img.shields.io/badge/JDK-1.8-blue.svg)](#sc-whorl)\n\nsc-whorl是一个基于springboot2.x的微服务开发脚手架,整合了多种开源框架配置,可以作为领域单体直接进行使用,可以根据自己的实际需求进行二次开发和扩展.\n\n此项目不但包括springBoot体系相关的配置集成示例,还包括了一些自定义的注解以及注解实现.包括**防重提交注解**,**限流注解**,**常用验证注解**以及扩展,另外为了方便开发还增加了对于**统一日志打印**,**统一异常处理**,**分页**,**分布式锁**等基础服务等一些常用规范示例.\n\n\n\n\n## 项目使用技术栈\n\n- springboot2.0\n- docker +docker plugin\n- mybatis +pageHelper\n- redis\n- springSecurity+jwt\n- swagger2\n- mysql\n- Spring Boot Cache\n- Srping Boot Mail\n\n## 自定义注解说明\n\n## @limit 应用服务器限流注解\n\n```java\n//限流 10秒内最多允许1000次访问\n@Limit(key = \"USER:LOGIN\", period = 10, count = 1000)\npublic MsgResponseBody\u003cJWTUserDetail\u003e login(@RequestJsonParam(\"userName\") String userName, @RequestJsonParam(\"passWord\") String passWord) {\n}\n```\n\n**注解字段说明**\n\n```java\n//资源的名字\nString name() default \"\";\n//资源的key\nString key() default \"\";\n//Key的前缀\nString prefix() default \"\";\n//给定的时间段,单位秒\nint period();\n//最多的访问限制次数\nint count();\n//类型\nLimitType limitType() default LimitType.CUSTOMER;\n```\n\n\n\n## @PreventResubmitLock \u0026 @PreventParam 应用服务防重提交\n\n```java\n//默认5秒内同一手机号不可重复提交\n@PreventResubmitLock(prefix = \"USER:REGISTER\")\npublic MsgResponseBody\u003cString\u003e register(@RequestBody @PreventParam(name = \"userPhone\") UserVo userVo) {\n    userService.register(userVo);\n    return MsgResponseBody.success().setResult(\"注册成功\");\n}\n```\n\n**注解字段说明**\n\n@PreventResubmitLock\n\n```java\n//redis 锁key的前缀\nString prefix() default \"\";\n//轮询锁的时间,过期秒数,默认为5秒\nint expire() default 5;\n//超时时间单位,秒\nTimeUnit timeUnit() default TimeUnit.SECONDS;\n//Key的分隔符（默认 :)\nString delimiter() default \":\";\n```\n\n@PreventParam\n\n```java\n//字段名称,即为防止重复提交的入参key,用于反射\nString name() default \"\";\n```\n\n## @RequestJsonParam 请求体为json的属性提取\n\n```java\npublic MsgResponseBody\u003cJWTUserDetail\u003e login(@RequestJsonParam(\"userName\") String userName, @RequestJsonParam(\"passWord\") String passWord) {\n}\n```\n\n**注解字段说明**\n\n```java\n//用于绑定的请求参数名字\nString value() default \"\" ;\n//是否必须，默认是\nboolean required() default true;\n//是否是当前json对象,默认false,表示当前josn对象中的某一个值,若是true,则忽略value\nboolean current() default false;\n//如果是日期类型的,设置其时间.默认为:yyyy-MM-dd HH:mm:ss\nString dateFormat() default YMDHMS;\n```\n\n# 项目部署\n\n- 新建mysql的whorl库编码格式为UTF-8,导入工程中的whorl_db.sql\n- 修改spring-boot的配置文件,数据库连接,redis连接等指向对应的配置路径\n- 以springboot或dockerFile的方式启动工程\n\n\n\n\n\n# 呜谢\n\n部分代码和参考实现来源于网络\n\n感谢\n\n[battch](https://blog.battcn.com/categories/SpringBoot/)\n\n[awesome-spring-boot](https://github.com/ityouknow/awesome-spring-boot)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSenssic%2Fsc-whorl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FSenssic%2Fsc-whorl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FSenssic%2Fsc-whorl/lists"}