{"id":15024523,"url":"https://github.com/insidezhou/southern-quiet","last_synced_at":"2025-10-04T05:08:06.394Z","repository":{"id":53546190,"uuid":"171787588","full_name":"InsideZhou/southern-quiet","owner":"InsideZhou","description":"这是一个基于Spring Boot，为了提供一些基础设施抽象，减少重复劳动而存在的库。","archived":false,"fork":false,"pushed_at":"2023-09-11T07:22:28.000Z","size":1304,"stargazers_count":8,"open_issues_count":0,"forks_count":9,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-12T06:38:38.039Z","etag":null,"topics":["debounce","event","job","notification","spring-boot","throttle"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/InsideZhou.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":"2019-02-21T02:42:21.000Z","updated_at":"2024-08-27T23:06:44.000Z","dependencies_parsed_at":"2024-10-14T04:40:51.398Z","dependency_job_id":"59e6ad90-301e-4804-9183-d5f1788a9edc","html_url":"https://github.com/InsideZhou/southern-quiet","commit_stats":null,"previous_names":[],"tags_count":44,"template":false,"template_full_name":null,"purl":"pkg:github/InsideZhou/southern-quiet","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InsideZhou%2Fsouthern-quiet","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InsideZhou%2Fsouthern-quiet/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InsideZhou%2Fsouthern-quiet/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InsideZhou%2Fsouthern-quiet/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/InsideZhou","download_url":"https://codeload.github.com/InsideZhou/southern-quiet/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/InsideZhou%2Fsouthern-quiet/sbom","scorecard":{"id":66653,"data":{"date":"2025-08-11","repo":{"name":"github.com/InsideZhou/southern-quiet","commit":"d6eb666a99f1a535d8f9c81c0b14d0db27fd341f"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.9,"checks":[{"name":"Code-Review","score":0,"reason":"Found 1/28 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":9,"reason":"binaries present in source code","details":["Warn: binary detected: gradle/wrapper/gradle-wrapper.jar:1"],"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: BSD 3-Clause \"New\" or \"Revised\" License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 3 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-15T02:44:28.772Z","repository_id":53546190,"created_at":"2025-08-15T02:44:28.772Z","updated_at":"2025-08-15T02:44:28.772Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278266896,"owners_count":25958733,"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-10-04T02:00:05.491Z","response_time":63,"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":["debounce","event","job","notification","spring-boot","throttle"],"created_at":"2024-09-24T20:00:30.037Z","updated_at":"2025-10-04T05:08:06.349Z","avatar_url":"https://github.com/InsideZhou.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"### 必须知道的细节\n1. 版本控制中忽略了application-default.properties文件，意味着本地调试时，可以往该文件中写入配置，覆盖一些值来适应本地开发环境。\n\n1. 每个模块都有与之对应的*AutoConfiguration类，模块依赖的外部配置使用*AutoConfiguration.*Properties来管理。\n\n1. 每个*AutoConfiguration类都有与之对应的spring.factories，以便在AutoConfigure时自动载入。\n\n\n### 提供的特性\n##### FileSystem 文件系统  \n\n\u003e 屏蔽底层细节，提供文件读写的支持，并且由于驱动的不同，可以做到不同机器上的应用共享同一个文件系统。\n\n- filesystem-spring-boot-starter-*\n- 考虑文件名的规范，在某些驱动上合法的文件名，在其他驱动上未必合法。需要跨驱动的应用，特别需要注意兼容性。查看FileSystemSupport.assertFileNameValid。\n- 考虑文件并发读写的问题。由于某些驱动在读文件时并不会独占文件，所以需要充分考虑事务的级别。\n\n##### Logging 日志\n\n- logging-spring-boot-starter-*\n- 由于Logger初始化时间的原因，基于FileSystem的FileAppender在FileSystem未能初始化时，默认不输出日志。\n    \n##### Auth 身份及权限验证\n\n- 提供Auth注解来验证身份及权限，使用在spring容器管理的bean及其方法上。\n- 通过实现AuthProvider接口来自定义验证逻辑。\n- 权限匹配使用org.springframework.util.PathMatcher（默认AntPathMatcher）进行。\n\n##### KeyValueStore 键值对存储（默认southern-quiet.framework.key-value.enable=false）\n\n- 默认驱动基于FileSystem，会有KEY规范的问题需要考虑。\n    \n##### IdGenerator 发号器/Id生成器\n\n- id-generator-spring-boot-starter-*\n    \n##### EventBroadcasting 事件广播 (At Most Once Message)\n\n\u003e 把基于Spring Event的自定义事件广播到当前ApplicationContext之外\n\u003e 为了支持跨语言事件，每个事件都有其唯一类型标识。\n\n- event-spring-boot-starter-*\n- me.insidezhou.southernquiet.event.ShouldBroadcast\n- me.insidezhou.southernquiet.event.CustomApplicationEvent\n    \n##### NotificationPublishing 通知发布 (At Least Once Message)\n\n- notification-spring-boot-starter-*\n    \n##### JobArranger 任务编排 (Exactly Once Message)\n\n- job-spring-boot-starter-*\n\n##### Debouncer 抖动去除器\n\n\u003e 对容器内某个bean的方法按指定时间去除抖动，抖动去除完成后肯定会得到执行。\n\n- me.insidezhou.southernquiet.debounce.*\n\n##### Throttle 节流器  \n\n\u003e 对容器内某个bean的方法按指定时间或次数节流，节流期间方法不会得到执行。\n\n- throttle-spring-boot-starter-*\n- me.insidezhou.southernquiet.throttle.Throttle\n- me.insidezhou.southernquiet.throttle.ThrottleManager\n\n\n### 如何使用\n1. 在应用入口类上使用SpringBootApplication或者EnableAutoConfiguration注解。\n\n\n### 需要注意的局限\n1. 因为Logging的特殊性，Logger的初始化在ApplicationContext之前，所以Logger的相关配置需要注意遵守Spring Boot的\n[约定](https://docs.spring.io/spring-boot/docs/2.0.6.RELEASE/reference/htmlsingle/#boot-features-custom-log-configuration)。\n\n1. 启用spring-boot-devtools的时候，可能会因为同一个类被不同ClassLoader载入导致类型判断失败。\n\n\n### 编码及设计风格\n1. 在文件系统上的目录，如果是框架使用默认值创建的，应该统一用大写路径名，保持适当的特征有助于应用维护时大致区分某个目录来自何处。\n1. 遇到bug，应该优先考虑设计一个或一组测试来捕获这个bug，以提高代码的质量及可维护性。\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finsidezhou%2Fsouthern-quiet","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finsidezhou%2Fsouthern-quiet","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finsidezhou%2Fsouthern-quiet/lists"}