useragent优化

[livk-cloud]

Sourcery 总结

增强功能：

• 通过添加缓存机制来存储解析后的 UserAgent 信息，减少冗余解析，从而提高性能。

Original summary in English

Summary by Sourcery

Enhancements:

• Improves performance by adding a caching mechanism to store parsed UserAgent information, reducing redundant parsing.

[sourcery-ai]

## Sourcery 评审指南

此 Pull Request 重构了 `UserAgent` 的实现，使用了接口和一个默认的 record，在 `AbstractUserAgentConverter` 中引入了缓存以提高性能，并更新了相关类以与这些更改保持一致。此外，它还向测试用例添加了断言，以验证特定字段的值。

#### 使用缓存的 UserAgent 转换的序列图

```mermaid
sequenceDiagram
  participant HttpHeaders
  participant AbstractUserAgentConverter
  participant Cache
  participant DefaultUserAgent

  HttpHeaders->>AbstractUserAgentConverter: convert(headers)
  AbstractUserAgentConverter->>Cache: computeIfAbsent(useragent, build)
  alt Cache miss
    Cache->>AbstractUserAgentConverter: build(useragent)
    AbstractUserAgentConverter->>DefaultUserAgent.UserAgentBuilder: builder(useragent)
    AbstractUserAgentConverter->>AbstractUserAgentConverter: create(useragent)
    AbstractUserAgentConverter->>AbstractUserAgentConverter: browser(t)
    AbstractUserAgentConverter->>AbstractUserAgentConverter: browserType(t)
    AbstractUserAgentConverter->>AbstractUserAgentConverter: browserVersion(t)
    AbstractUserAgentConverter->>AbstractUserAgentConverter: os(t)
    AbstractUserAgentConverter->>AbstractUserAgentConverter: osVersion(t)
    AbstractUserAgentConverter->>AbstractUserAgentConverter: deviceType(t)
    AbstractUserAgentConverter->>AbstractUserAgentConverter: deviceName(t)
    AbstractUserAgentConverter->>AbstractUserAgentConverter: deviceBrand(t)
    AbstractUserAgentConverter->>DefaultUserAgent.UserAgentBuilder: build()
    DefaultUserAgent.UserAgentBuilder-->>AbstractUserAgentConverter: UserAgent
    AbstractUserAgentConverter->>Cache: return UserAgent
  end
  Cache-->>AbstractUserAgentConverter: UserAgent
  AbstractUserAgentConverter-->>HttpHeaders: UserAgent

文件级别变更

变更	详情	文件
将 UserAgent 重构为一个接口，并引入 DefaultUserAgent record 作为其实现。	引入 UserAgent 接口。 创建实现 UserAgent 接口的 DefaultUserAgent record。 修改 UserAgentBuilder 以嵌套在 DefaultUserAgent 中并返回 DefaultUserAgent 实例。 更新 UserAgent 的用法以使用 DefaultUserAgent。	spring-extension-context/src/main/java/com/livk/context/useragent/DefaultUserAgent.java spring-extension-context/src/main/java/com/livk/context/useragent/UserAgent.java
在 AbstractUserAgentConverter 中为 UserAgent 对象实现缓存以提高性能。	向 AbstractUserAgentConverter 添加一个 cache 字段以存储 UserAgent 对象。 修改 convert 方法，如果用户代理字符串已存在，则使用缓存。 引入一个 build 方法来封装 UserAgent 对象的创建。 更新 AbstractUserAgentConverter 中的 create 方法以直接接受用户代理字符串，而不是 HttpHeaders。	spring-extension-context/src/main/java/com/livk/context/useragent/AbstractUserAgentConverter.java
更新 YauaaUserAgentConverter 和 BrowscapUserAgentConverter 以与 AbstractUserAgentConverter 中的更改保持一致。	修改 create 方法以直接接受用户代理字符串。 从 create 方法中删除 header 提取逻辑。	spring-extension-context/src/main/java/com/livk/context/useragent/yauaa/YauaaUserAgentConverter.java spring-extension-context/src/main/java/com/livk/context/useragent/browscap/BrowscapUserAgentConverter.java
向 UserControllerTest 中的 testList 方法添加断言，以验证 appId 和 version 字段的值。	添加 jsonPath 断言以检查响应中 appId 和 version 的值。	spring-boot-example/spring-clickhouse/spring-clickhouse-jdbc/src/test/java/com/livk/ck/jdbc/controller/UserControllerTest.java

---

提示和命令

与 Sourcery 互动

• 触发新的审查： 在 Pull Request 上评论 @sourcery-ai review。
• 继续讨论： 直接回复 Sourcery 的审查评论。
• 从审查评论生成 GitHub issue： 通过回复 Sourcery 的审查评论来请求创建 issue。您也可以回复评论并使用 @sourcery-ai issue 来创建 issue。
• 生成 Pull Request 标题： 在 Pull Request 标题中的任何位置写入 @sourcery-ai 以随时生成标题。您也可以在 Pull Request 上评论 @sourcery-ai title 以随时（重新）生成标题。
• 生成 Pull Request 摘要： 在 Pull Request 正文中的任何位置写入 @sourcery-ai summary 以随时在您想要的位置生成 PR 摘要。您也可以在 Pull Request 上评论 @sourcery-ai summary 以随时（重新）生成摘要。
• 生成评审指南： 在 Pull Request 上评论 @sourcery-ai guide 以随时（重新）生成评审指南。
• 解决所有 Sourcery 评论： 在 Pull Request 上评论 @sourcery-ai resolve 以解决所有 Sourcery 评论。如果您已经处理了所有评论并且不想再看到它们，这将非常有用。
• 驳回所有 Sourcery 审查： 在 Pull Request 上评论 @sourcery-ai dismiss 以驳回所有现有的 Sourcery 审查。如果您想重新开始新的审查，这将特别有用 - 不要忘记评论 @sourcery-ai review 以触发新的审查！
• 为 issue 生成行动计划： 在 issue 上评论 @sourcery-ai plan 以生成行动计划。

自定义您的体验

访问您的 仪表板 以：

• 启用或禁用审查功能，例如 Sourcery 生成的 Pull Request 摘要、评审指南等。
• 更改审查语言。
• 添加、删除或编辑自定义审查说明。
• 调整其他审查设置。

获取帮助

• 联系我们的支持团队 提出问题或反馈。
• 访问我们的 文档 获取详细的指南和信息。
• 通过在 X/Twitter, LinkedIn 或 GitHub 上关注我们，与 Sourcery 团队保持联系。

```

Original review guide in English

Reviewer's Guide by Sourcery

This pull request refactors the UserAgent implementation to use an interface and a default record, introduces caching in the AbstractUserAgentConverter to improve performance, and updates related classes to align with these changes. Additionally, it adds assertions to a test case to verify specific field values.

Sequence diagram for UserAgent conversion with caching

sequenceDiagram
  participant HttpHeaders
  participant AbstractUserAgentConverter
  participant Cache
  participant DefaultUserAgent

  HttpHeaders->>AbstractUserAgentConverter: convert(headers)
  AbstractUserAgentConverter->>Cache: computeIfAbsent(useragent, build)
  alt Cache miss
    Cache->>AbstractUserAgentConverter: build(useragent)
    AbstractUserAgentConverter->>DefaultUserAgent.UserAgentBuilder: builder(useragent)
    AbstractUserAgentConverter->>AbstractUserAgentConverter: create(useragent)
    AbstractUserAgentConverter->>AbstractUserAgentConverter: browser(t)
    AbstractUserAgentConverter->>AbstractUserAgentConverter: browserType(t)
    AbstractUserAgentConverter->>AbstractUserAgentConverter: browserVersion(t)
    AbstractUserAgentConverter->>AbstractUserAgentConverter: os(t)
    AbstractUserAgentConverter->>AbstractUserAgentConverter: osVersion(t)
    AbstractUserAgentConverter->>AbstractUserAgentConverter: deviceType(t)
    AbstractUserAgentConverter->>AbstractUserAgentConverter: deviceName(t)
    AbstractUserAgentConverter->>AbstractUserAgentConverter: deviceBrand(t)
    AbstractUserAgentConverter->>DefaultUserAgent.UserAgentBuilder: build()
    DefaultUserAgent.UserAgentBuilder-->>AbstractUserAgentConverter: UserAgent
    AbstractUserAgentConverter->>Cache: return UserAgent
  end
  Cache-->>AbstractUserAgentConverter: UserAgent
  AbstractUserAgentConverter-->>HttpHeaders: UserAgent

Loading

File-Level Changes

Change	Details	Files
Refactor UserAgent to an interface and introduce a DefaultUserAgent record as its implementation.	Introduce a UserAgent interface. Create a DefaultUserAgent record implementing the UserAgent interface. Modify the UserAgentBuilder to be nested within DefaultUserAgent and return DefaultUserAgent instances. Update usages of UserAgent to use DefaultUserAgent.	spring-extension-context/src/main/java/com/livk/context/useragent/DefaultUserAgent.java spring-extension-context/src/main/java/com/livk/context/useragent/UserAgent.java
Implement caching for UserAgent objects in AbstractUserAgentConverter to improve performance.	Add a cache field to AbstractUserAgentConverter to store UserAgent objects. Modify the convert method to use the cache if the user agent string is already present. Introduce a build method to encapsulate the creation of UserAgent objects. Update the create method in AbstractUserAgentConverter to accept the user agent string directly instead of HttpHeaders.	spring-extension-context/src/main/java/com/livk/context/useragent/AbstractUserAgentConverter.java
Update YauaaUserAgentConverter and BrowscapUserAgentConverter to align with changes in AbstractUserAgentConverter.	Modify the create method to accept the user agent string directly. Remove the header extraction logic from the create method.	spring-extension-context/src/main/java/com/livk/context/useragent/yauaa/YauaaUserAgentConverter.java spring-extension-context/src/main/java/com/livk/context/useragent/browscap/BrowscapUserAgentConverter.java
Add assertions to the testList method in UserControllerTest to verify the values of appId and version fields.	Add jsonPath assertions to check the values of appId and version in the response.	spring-boot-example/spring-clickhouse/spring-clickhouse-jdbc/src/test/java/com/livk/ck/jdbc/controller/UserControllerTest.java

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

嘿 @livk-cloud - 我已经查看了你的更改 - 这里有一些反馈：

总体评论：

• 考虑使用比 DefaultUserAgent 更具描述性的名称来实现 UserAgent 接口。
• AbstractUserAgentConverter 中的缓存可能会无限增长；考虑添加最大大小或驱逐策略。

这是我在审查期间查看的内容

• 🟢 一般问题：一切看起来都很好
• 🟢 安全性：一切看起来都很好
• 🟢 测试：一切看起来都很好
• 🟢 复杂性：一切看起来都很好
• 🟢 文档：一切看起来都很好

---

Sourcery 对开源是免费的 - 如果你喜欢我们的评论，请考虑分享它们 ✨

• X
• Mastodon
• LinkedIn
• Facebook

<sub>帮助我更有用！请点击每个评论上的 👍 或 👎，我将使用反馈来改进你的评论。</sub>

Original comment in English

Hey @livk-cloud - I've reviewed your changes - here's some feedback:

Overall Comments:

• Consider using a more descriptive name than DefaultUserAgent for the implementation of the UserAgent interface.
• The cache in AbstractUserAgentConverter might grow unbounded; consider adding a maximum size or eviction policy.

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

<sub>Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.</sub>

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 59.12%. Comparing base (02ef412) to head (de5c105).

✅ All tests successful. No failed tests found.

Additional details and impacted files

@@             Coverage Diff              @@
##               main     #603      +/-   ##
============================================
- Coverage     59.13%   59.12%   -0.02%     
  Complexity     1233     1233              
============================================
  Files           431      431              
  Lines          5127     5125       -2     
  Branches        365      365              
============================================
- Hits           3032     3030       -2     
  Misses         1872     1872              
  Partials        223      223              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.