ViewfinderView
July 7, 2025 · View on GitHub
ViewfinderView 是一个取景视图：主要用于渲染扫描相关的动画效果。其样式主要分为两大类：classic：经典样式（带扫描框）、popular：流行样式（不带扫描框）；可任意定制。
如果你之前有使用过 ZXingLite 或 MLKit，可能会用到其内部的 ViewfinderView。现已将 ViewfinderView 独立出来，便于后续统一维护。
目前ZXingLite、MLKit、WeChatQRCode 都已使用了此 ViewfinderView 作为通用的扫描渲染视图。
效果展示
你也可以直接下载 演示App 体验效果
引入
Gradle:
-
在Project的 build.gradle 或 setting.gradle 中添加远程仓库
repositories { //... mavenCentral() } -
在Module的 build.gradle 中添加依赖项
implementation 'com.github.jenly1314:viewfinderview:1.4.0'
使用
ViewfinderView属性说明
| 属性 | 属性类型 | 默认值 | 属性说明 |
|---|---|---|---|
| vvViewfinderStyle | enum | classic | 取景框样式；支持classic：经典样式（带扫描框）、popular：流行样式（不带扫描框） |
| vvMaskColor | color | #60000000 | 扫描区外遮罩的颜色 |
| vvFrameColor | color | #7F1FB3E2 | 扫描框边框的颜色 |
| vvFrameWidth | dimension | 扫描框宽度 | |
| vvFrameHeight | dimension | 扫描框高度 | |
| vvFrameRatio | float | 0.625f | 扫描框与屏幕占比,当未设置扫描框的宽高时，使用占比来计算宽高 |
| vvFrameLineStrokeWidth | dimension | 1dp | 边框线宽度 |
| vvFramePaddingLeft | dimension | 0 | 扫描框左边的内间距 |
| vvFramePaddingTop | dimension | 0 | 扫描框上边的内间距 |
| vvFramePaddingRight | dimension | 0 | 扫描框右边的内间距 |
| vvFramePaddingBottom | dimension | 0 | 扫描框下边的内间距 |
| vvFrameGravity | enum | center | 扫描框对齐方式 |
| vvFrameCornerColor | color | #FF1FB3E2 | 扫描框边角的颜色 |
| vvFrameCornerSize | dimension | 16dp | 扫描框边角的大小 |
| vvFrameCornerStrokeWidth | dimension | 4dp | 扫描框边角的描边宽度 |
| vvFrameCornerRadius | dimension | 0dp | 扫描框圆角半径 |
| vvFrameDrawable | reference | 扫描框自定义图片 | |
| vvLaserLineHeight | dimension | 5dp | 激光扫描线高度 |
| vvLaserMovementSpeed | dimension | 2dp | 激光扫描线的移动速度 |
| vvLaserAnimationInterval | integer | 20 | 扫描动画延迟间隔时间，单位：毫秒 |
| vvLaserGridColumn | integer | 20 | 网格激光扫描列数 |
| vvLaserGridHeight | dimension | 40dp | 网格激光扫描高度，为0dp时，表示动态铺满 |
| vvLaserGridStrokeWidth | dimension | 1dp | 网格线条的宽 |
| vvLaserColor | color | #FF1FB3E2 | 扫描区激光线的颜色 |
| vvLaserStyle | enum | line | 激光扫描的样式 |
| vvLaserDrawable | reference | 激光扫描线自定义图片 | |
| vvLaserDrawableRatio | float | 0.625f | 激光扫描图片与屏幕占比 |
| vvLabelText | string | 扫描提示文本信息 | |
| vvLabelTextColor | color | #FFC0C0C0 | 提示文本字体颜色 |
| vvLabelTextSize | dimension | 14sp | 提示文本字体大小 |
| vvLabelTextPadding | dimension | 24dp | 提示文本距离扫描框的间距 |
| vvLabelTextWidth | dimension | 提示文本的宽度，默认为View的宽度 | |
| vvLabelTextLocation | enum | bottom | 提示文本显示位置 |
| vvPointColor | color | #FF1FB3E2 | 结果点的颜色 |
| vvPointStrokeColor | color | #FFFFFFFF | 结果点描边的颜色 |
| vvPointRadius | dimension | 15dp | 结果点的半径 |
| vvPointStrokeRatio | float | 1.2 | 结果点描边半径与结果点半径的比例 |
| vvPointDrawable | reference | 结果点自定义图片 | |
| vvPointAnimation | boolean | true | 是否显示结果点的动画 |
| vvPointAnimationInterval | integer | 3000 | 结果点动画间隔时长；单位：毫秒 |
| vvFullRefresh | boolean | false | 是否完全刷新；适用于vvViewfinderStyle为classic经典样式（带扫描框）时 |
ViewfinderView相关的自定义属性统一使用 vv 开头。
示例
布局示例
ViewfinderView 相关的自定义属性可查看上面的 ViewfinderView属性说明
<com.king.view.viewfinderview.ViewfinderView
android:id="@+id/viewfinderView"
android:layout_width="match_parent"
android:layout_height="match_parent"
app:vvLaserStyle="line" />
更多使用详情，请查看app中的源码使用示例或直接查看 API帮助文档
相关推荐
- ZXingLite 基于zxing实现的扫码库，优化扫码和生成二维码/条形码功能。
- MLKit 一个强大易用的工具包。通过ML Kit您可以很轻松的实现文字识别、条码识别、图像标记、人脸检测、对象检测等功能。
- WeChatQRCode 基于OpenCV开源的微信二维码引擎移植的扫码识别库。
- CameraScan 一个简化扫描识别流程的通用基础库。
- LibYuv 基于Google的libyuv编译封装的YUV转换工具库，主要用途是在各种YUV与RGB之间进行相互转换、裁减、旋转、缩放、镜像等。
版本日志
v1.4.0：2025-7-7
- 迁移发布至 Central Portal 相关公告
- 更新Gradle至v8.5
- 优化一些细节
查看更多版本日志
