refactor: use compatible systemInfo util API #2975
Open
+57
−27
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Walkthrough此次 PR 主要针对多个组件中获取系统窗口信息的方式进行了统一调整。原先使用 Taro.getSystemInfoSync() 的调用均替换为 getWindowInfo()，以获取窗口尺寸和像素比，其中部分组件如 pulltorefresh 采用 Taro.getDeviceInfo().platform 获取平台信息。其余业务逻辑（如拖拽、裁剪、滚动处理等）保持不变。 Changes
Possibly related issues
Possibly related PRs
Suggested reviewers
Poem
✨ Finishing Touches
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## feat_v3.x #2975 +/- ##
==========================================
Coverage 85.74% 85.74%
==========================================
Files 277 277
Lines 18105 18105
Branches 2745 2745
==========================================
Hits 15524 15524
Misses 2576 2576
Partials 5 5 ☔ View full report in Codecov by Sentry. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
src/packages/drag/drag.taro.tsx (1)
2-2: 建议添加错误处理虽然替换 API 是正确的，但考虑到这些值用于边界计算，建议添加错误处理：
- const { screenWidth, windowHeight } = getWindowInfo() + try { + const { screenWidth, windowHeight } = getWindowInfo() + if (!screenWidth || !windowHeight) { + console.warn('获取窗口信息失败', { screenWidth, windowHeight }) + return + } + } catch (error) { + console.error('获取窗口信息出错', error) + return + }Also applies to: 67-67
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (8)
src/packages/avatarcropper/avatarcropper.taro.tsx(2 hunks)src/packages/drag/demos/taro/demo4.tsx(1 hunks)src/packages/drag/drag.taro.tsx(2 hunks)src/packages/lottie/mp.taro.tsx(2 hunks)src/packages/menuitem/menuitem.taro.tsx(4 hunks)src/packages/pulltorefresh/pulltorefresh.taro.tsx(1 hunks)src/packages/sticky/sticky.taro.tsx(2 hunks)src/packages/virtuallist/virtuallist.taro.tsx(2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: test
🔇 Additional comments (7)
src/packages/drag/demos/taro/demo4.tsx (1)
3-3: 代码更改正确！成功将已弃用的
getSystemInfoSync替换为getWindowInfo，并且保持了相同的属性访问方式。Also applies to: 6-6
src/packages/lottie/mp.taro.tsx (1)
5-5: 请验证 pixelRatio 的准确性虽然替换为
getWindowInfo是正确的，但由于这个值用于画布缩放，建议验证在不同设备上的显示效果。Also applies to: 34-34
✅ Verification successful
🌐 Web query:
Taro getWindowInfo 和 getSystemInfoSync 返回的 pixelRatio 是否完全一致？💡 Result:
Taro框架中`getWindowInfo`和`getSystemInfoSync`返回的`pixelRatio`值**完全一致**。根据文档分析： 1. **数据来源相同** 两者均从底层系统接口获取设备像素比（Device Pixel Ratio），属于同一数据源的不同访问方式[3][5][10]。 2. **定义一致性** Taro官方文档明确标注两者返回的`pixelRatio`参数说明均为： > 设备像素比 = 物理像素 / 逻辑像素 且类型均为`number`[3][10]。 3. **单位与计算规则统一** 两者的`pixelRatio`计算规则完全遵循Web标准（与Web API的`devicePixelRatio`一致），不涉及平台差异或框架层二次计算[1][9]。 4. **使用场景差异** - `getSystemInfoSync()`：获取完整的系统信息（含品牌、型号、屏幕尺寸等） - `getWindowInfo()`：聚焦窗口可用区域信息（如状态栏/TabBar高度等），但核心参数如`pixelRatio`仍复用系统接口数据[5][8] 实际开发中可互换使用两者的`pixelRatio`值（如响应式布局或Canvas绘制场景）[7][9]。但建议优先使用`getSystemInfoSync()`以保证代码兼容性更广。 Citations: - 1: https://developers.weixin.qq.com/community/develop/doc/1d3d06e7f4bfd425630c91e875e31ab1 - 2: https://blog.csdn.net/cong_user/article/details/114932914 - 3: https://docs.taro.zone/docs/1.x/apis/device/systeminfo/getSystemInfoSync/ - 4: https://developers.weixin.qq.com/miniprogram/dev/component/scroll-view.html - 5: https://docs.taro.zone/docs/2.x/apis/base/system/getSystemInfoSync/ - 6: https://failte.cn/pages/93aad5/ - 7: https://juejin.cn/post/7153880013962477598 - 8: https://developers.weixin.qq.com/miniprogram/dev/framework/custom-component/ - 9: https://developers.weixin.qq.com/community/personal/oCJUsw9Ri1fmAJmg-oqw8tWjKwG0/fav - 10: https://docs.taro.zone/docs/apis/base/system/getSystemInfoSync
验证 pixelRatio 准确性
根据 Taro 官方文档及相关资料，
getWindowInfo和getSystemInfoSync返回的pixelRatio值完全一致，这意味着用getWindowInfo替换不会影响 Canvas 的缩放效果。当然，仍建议在不同设备上做终端测试以确保实际显示效果达到预期。
- 确认了
getWindowInfo与getSystemInfoSync的pixelRatio数值一致- 涉及文件：src/packages/lottie/mp.taro.tsx（适用于行 5 及 34）
src/packages/sticky/sticky.taro.tsx (1)
13-13: 代码更改正确！成功将
getSystemInfoSync替换为getWindowInfo获取窗口高度，保持了相同的功能。Also applies to: 132-132
src/packages/virtuallist/virtuallist.taro.tsx (1)
11-11: 代码更改正确！成功将已弃用的
getSystemInfoSync替换为getWindowInfo，同时保持了原有的回退值逻辑。Also applies to: 59-59
src/packages/pulltorefresh/pulltorefresh.taro.tsx (1)
162-162: 平台检测 API 更改正确！使用
getDeviceInfo().platform替代getSystemInfoSync().platform是正确的选择，因为getDeviceInfoAPI 更适合获取平台信息。src/packages/menuitem/menuitem.taro.tsx (1)
12-12: 窗口信息获取方式更新正确！成功将所有
getSystemInfoSync调用替换为getWindowInfo，保持了组件的定位逻辑不变。Also applies to: 109-109, 166-166, 180-180
src/packages/avatarcropper/avatarcropper.taro.tsx (1)
11-11: 系统信息获取方式更新正确！成功将
getSystemInfoSync替换为getWindowInfo，同时保持了像素比和窗口尺寸的计算逻辑不变。Also applies to: 125-125
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
src/utils/get-system-info.ts (4)
7-13: 建议增加错误处理机制当前实现在 API 调用失败时没有错误处理逻辑。建议添加 try-catch 块来优雅处理可能的异常。
建议修改为：
export function getDeviceInfo(): IDeviceInfo { + try { if (Taro.canIUse('getDeviceInfo')) { return Taro.getDeviceInfo() } return Taro.getSystemInfoSync() + } catch (error) { + console.error('获取设备信息失败:', error) + throw error + } }
16-22: 建议增加返回值类型校验为确保新旧 API 返回的数据结构一致性，建议添加类型校验逻辑。
建议添加类型校验函数：
function validateWindowInfo(info: any): info is Taro.getWindowInfo.Result { return typeof info.windowWidth === 'number' && typeof info.windowHeight === 'number' && typeof info.pixelRatio === 'number' }然后修改实现：
export function getWindowInfo(): Taro.getWindowInfo.Result { + let info if (Taro.canIUse('getWindowInfo')) { - return Taro.getWindowInfo() + info = Taro.getWindowInfo() + } else { + info = Taro.getSystemInfoSync() } - return Taro.getSystemInfoSync() + if (!validateWindowInfo(info)) { + throw new Error('获取到的窗口信息格式不正确') + } + return info }
24-31: 建议添加详细的 JSDoc 文档为了提高代码可维护性，建议添加完整的 JSDoc 文档说明，包括函数描述、返回值说明和示例代码。
建议添加如下文档：
+/** + * 获取应用基础信息 + * @description 优先使用新版 API getAppBaseInfo，不可用时回退到 getSystemInfoSync + * @returns {Taro.getAppBaseInfo.Result} 应用基础信息 + * @example + * const appInfo = getAppBaseInfo() + * console.log(appInfo.language) // 显示当前应用设置的语言 + */ export function getAppBaseInfo(): Taro.getAppBaseInfo.Result { if (Taro.canIUse('getAppBaseInfo')) { return Taro.getAppBaseInfo() } return Taro.getSystemInfoSync() }
1-32: 建议重构以减少代码重复当前三个函数有相似的实现模式，建议提取共同逻辑到一个工具函数中。
建议添加通用工具函数：
function getInfo<T>( newApi: () => T, newApiName: string, validate?: (data: any) => data is T ): T { try { const info = Taro.canIUse(newApiName) ? newApi() : Taro.getSystemInfoSync() if (validate && !validate(info)) { throw new Error(`Invalid ${newApiName} result`) } return info } catch (error) { console.error(`Failed to get info using ${newApiName}:`, error) throw error } }这样可以简化现有函数的实现，提高代码的可维护性和可测试性。
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (9)
src/packages/avatarcropper/avatarcropper.taro.tsx(2 hunks)src/packages/drag/demos/taro/demo4.tsx(1 hunks)src/packages/drag/drag.taro.tsx(2 hunks)src/packages/lottie/mp.taro.tsx(2 hunks)src/packages/menuitem/menuitem.taro.tsx(4 hunks)src/packages/pulltorefresh/pulltorefresh.taro.tsx(2 hunks)src/packages/sticky/sticky.taro.tsx(2 hunks)src/packages/virtuallist/virtuallist.taro.tsx(2 hunks)src/utils/get-system-info.ts(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (8)
- src/packages/sticky/sticky.taro.tsx
- src/packages/lottie/mp.taro.tsx
- src/packages/pulltorefresh/pulltorefresh.taro.tsx
- src/packages/drag/drag.taro.tsx
- src/packages/virtuallist/virtuallist.taro.tsx
- src/packages/menuitem/menuitem.taro.tsx
- src/packages/drag/demos/taro/demo4.tsx
- src/packages/avatarcropper/avatarcropper.taro.tsx
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: test
🔇 Additional comments (1)
src/utils/get-system-info.ts (1)
3-4: 接口定义清晰简洁！通过 Omit 工具类型排除了不稳定的属性，增强了跨版本兼容性。
Alex-huxiyang
changed the title
xiaoyatong
reviewed
Feb 8, 2025
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
src/utils/get-system-info.ts (1)
20-34: 建议重构以减少代码重复三个函数有相似的模式，建议提取共同逻辑到一个通用函数中。
+const getCompatibleInfo = <T>( + apiName: string, + newApi: () => T, +): T => { + return Taro.canIUse(apiName) + ? newApi() + : Taro.getSystemInfoSync() +} + export const getWindowInfo = (): Taro.getWindowInfo.Result => { - return Taro.canIUse('getWindowInfo') - ? Taro.getWindowInfo() - : Taro.getSystemInfoSync() + return getCompatibleInfo('getWindowInfo', Taro.getWindowInfo) } export const getAppBaseInfo = (): Taro.getAppBaseInfo.Result => { - return Taro.canIUse('getAppBaseInfo') - ? Taro.getAppBaseInfo() - : Taro.getSystemInfoSync() + return getCompatibleInfo('getAppBaseInfo', Taro.getAppBaseInfo) }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/utils/get-system-info.ts(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: test
🔇 Additional comments (3)
src/utils/get-system-info.ts (3)
3-4: 接口定义清晰且类型安全！通过 Omit 工具类型排除不需要的属性，保持了类型定义的精确性。
1-34: 代码结构规范，符合之前的审查建议！
- 统一使用
export const xx = () => {}的导出语法- 每个函数都有清晰的 JSDoc 注释
- 类型定义完整
10-14: 🏁 Script executed:#!/bin/bash # 搜索 getSystemInfoSync 的返回类型使用情况 ast-grep --pattern 'getSystemInfoSync()' -l typescriptLength of output: 56
github-actions
bot
added
the
action:review
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
https://developers.weixin.qq.com/miniprogram/dev/api/base/system/wx.getSystemInfoSync.html
Summary by CodeRabbit
Summary by CodeRabbit