Docs & rules

hs-web/hsweb-frameworkGitHub

This is a public, read-only report. Striff reads this repository's docs, turns each sentence that makes a claim about the code into a rule, and checks the rule against the code on the default branch. How this works

1 stale name in these docs.

5.0.x5e471acLast read Oct 2

Is this yours? Install to manage it

Once installed, Striff checks every pull request.

Rules summary
Documents
Rules
12
11
8
1 stale name
8
3
3
1
1
17 docs
hs-web/hsweb-frameworkOpen repository

Stale names in these docs1

Each sentence below has a stale name: a type the default branch doesn't declare, or declares somewhere else. Edit the doc so it matches the code, or bring the type back.

  • GoneRequiresDataAccess
    注解名称 @RequiresDataAccess , 说明 数据权限控制

    The repository once had hsweb-authorization/hsweb-authorization-api/src/main/java/org/hswebframework/web/authorization/annotation/RequiresDataAccess.java. It doesn't now. Closest names there: DataAccess, DataAccessType.

    View on GitHub

hs-web/hsweb-framework — documented rules

12 of 12 rules, printed November 17, 2026.

The sentence in your docs
响应式请求先由 ReactiveUserTokenParser 提取 ParsedToken,再由 UserTokenWebFilter 写入 Reactor Context。UserTokenReactiveAuthenticationSupplier 读取该上下文并通过 UserTokenManager 校验有状态用户令牌,最后加载 Authentication。
3 rules from this sentence
ReactiveUserTokenParser depends on ParsedToken
Holds
UserTokenReactiveAuthenticationSupplier depends on UserTokenManager
Holds
UserTokenReactiveAuthenticationSupplier depends on Authentication
Holds
新增的 ReactiveTokenAuthenticationProvider 用于按 ParsedToken.type 接管原始令牌的 响应式认证,例如结构化 API Token、个人令牌或其他无状态令牌。Provider 负责完整验证 令牌并返回最终 Authentication,不创建 hsweb 用户令牌记录。
2 rules from this sentence
ReactiveTokenAuthenticationProvider depends on ParsedToken
Holds
ReactiveTokenAuthenticationProvider depends on Authentication
Holds
ReactiveTokenAuthenticationProvider#getTokenType() 返回稳定、非空、大小写敏感的唯一 路由键。初始化时空类型或重复类型立即失败,不能依赖 Bean 注册顺序覆盖。
ReactiveTokenAuthenticationProvider has a getTokenType method
Holds
统一结构化 Token Parser 应保持无阻塞、无数据库访问,只负责提取和低成本分类。未命中 保留前缀时返回空;命中保留前缀后,即使令牌非法也必须归属对应 Provider,不能回退普通 Bearer 或有状态 Token。UserTokenWebFilter 继续保留原有 ReactiveLogger 请求上下文。
UserTokenWebFilter depends on ReactiveLogger
Holds
ThirdPartReactiveAuthenticationManager 保持已发布的 getByUserId 职责,并通过 JavaDoc 与原始令牌认证 Provider 明确分工。
ThirdPartReactiveAuthenticationManager has getByUserId
Holds
使用hsweb-authorization-api提供的监听器,类UserOnSignIn监听用户授权事件AuthorizationSuccessEvent 当用户完成授权(授权方式可自行实现或者使用框架默认的授权方式,主要触发该事件即可).授权通过后会触发该事件.流程如下
UserOnSignIn depends on AuthorizationSuccessEvent
Holds
与授权同理,类UserOnSignOut监听AuthorizationExitEvent ,当触发事件后,调用UserTokenManager移除当前登录的token信息
2 rules from this sentence
UserOnSignOut depends on AuthorizationExitEvent
Holds
UserOnSignOut depends on UserTokenManager
Holds
AccessLoggerListener接口并注入到spring容器, 当有日志产生时,会调用接口方法onLogger,并传入日志信息
AccessLoggerListener has onLogger
Holds
12 rules from 3 docs

More open-source reports

Every report →

Other public repositories whose docs Striff read and checked against their code.