Bitwarden 贡献文档
⮐ Bitwarden Contributing Documentation我的博客联系我
  • 关于
  • 入门
    • 概述
    • 工具
    • 服务器
      • 设置指南
      • 高级服务器设置
      • 数据库
        • MSSQL
        • 实体框架
      • 事件日志
      • Ingress 隧道
      • SCIM
      • 自托管指南
      • 系统管理门户
      • 单点登录 (SSO)
        • 本地 IdP
        • Okta
      • 故障排除
      • 用户机密
      • 公共 API
    • 网页客户端
      • 网页密码库
        • WebAuthn
      • 浏览器端
        • 生物识别解锁
        • Firefox 隐私模式
      • 桌面端
        • Mac App Store Dev
        • Microsoft Store
        • Native Messaging Test Runner
        • 更新测试
      • CLI
      • 故障排除
    • 移动端
      • Android
        • F-Droid
      • iOS
      • .NET MAUI (legacy)
        • Android
        • iOS
        • watchOS
    • SDK
      • 内部 SDK
      • Secrets Manager
        • Integrations
          • Kubernetes
    • 业务 App
      • 目录连接器
        • JumpCloud
        • OpenLDAP Docker 服务器
      • Key Connector
      • Splunk App
  • 贡献
    • 贡献
    • 代码样式
      • =Android & Kotlin
      • Angular & TypeScript
      • C#
      • =Rust
      • T-SQL
      • =Swift
      • Tailwind
    • 数据库迁移
      • 进化数据库设计
    • 提交签名
    • 拉取请求
      • =贡献审查程序
      • 分支
      • 代码审查
      • UI 审查 - Chromatic
    • 无障碍
    • 依赖管理
    • 功能标记
    • 模板存储库
    • 测试
      • =数据库集成测试
      • 负载测试
      • 单元测试
        • 命名约定
        • 测试结构
    • 修改用户机密
  • 架构
    • 架构
    • 架构决策记录 (ADR)
      • 0001 - Angular Reactive Forms
      • 0002 - Public API for modules
      • 0003 - Adopt Observable Data Services for Angular
      • 0004 - Refactor State Service
      • 0005 - Refactor Api Service
      • 0006 - Clients: Use Jest Mocks
      • 0007 - Manifest V3 sync Observables
      • 0008 - Server: Adopt CQRS
      • 0009 - Composition over inheritance
      • 0010 - Angular Modules
      • 0011 - Scalable Angular Clients folder structure
      • 0012 - Angular Filename convention
      • 0013 - Avoid layered folder structure for request/response models
      • 0014 - Adopt Typescript Strict flag
      • 0015 - Short Lived Browser Services
      • 0016 - Move Decryption and Encryption to Views
      • 0017 - Use Swift to build watchOS app
      • 0018 - Feature management
      • 0019 - Adoption of Web Push
      • 0020 - Observability with OpenTelemetry
      • 0021 - Logging to Standard Output
      • =0022 - Authorization
      • =0023 - Identifying Integrated Clients
    • 移动客户端架构
      • =Android
      • =iOS
        • =推送通知故障排除提示
      • =.NET MAUI (legacy)
        • =概述
        • watchOS
    • =SDK 架构
      • =数据模型
      • =依赖
      • Password Manager
        • Web
          • =互操作性
      • =Secrets Manager
      • =服务器绑定
      • =版本控制和破坏性更改
    • 网络客户端架构
      • 概述
      • 数据模型
      • 表示层
        • Angular
        • CLI
      • =依赖注入
      • 服务层
        • Vision
        • 实现
    • 服务器架构
    • 深度剖析
      • 身份验证
        • 双重身份验证
      • =授权
      • =浏览器自动填充
        • 收集页面详细信息
        • 生成并执行填充脚本
        • 表单提交检测
        • Shadow DOM
        • =内联自动填充菜单
      • Captcha
      • =只读数据库副本
      • 事件日志
      • =FIDO2 和通行密钥
        • =凭据
        • =操作
        • =命名惯例
        • =实现
          • =提供程序
            • =浏览器扩展
          • =依赖方
            • =用于解密的通行密钥
        • =术语表
      • 推送通知
        • 移动端推送通知
        • 其他客户端推送通知
      • =SSH 密钥和代理
        • =SSH 代理
      • =状态提供程序框架
        • =派生状态
    • =安全
      • =定义
      • =原则
        • =P01 - 锁定的密码库是安全的
        • =P02 - 半受损设备密码库的有限安全性
        • =P03 - 完全损坏的系统没有安全性
        • =P04 - 控制密码库数据的访问权限
        • =P05 - 将安全漏洞的影响降至最低
      • =要求
由 GitBook 提供支持
在本页
  • 要求
  • 设置
  • 依赖
  1. 入门
  2. 移动端

Android

上一页移动端下一页F-Droid

最后更新于1个月前

对应的

要求

  • Android Studio - 最新稳定版本

  • Android SDK - 对于 SDK 平台版本,请参考 文件中的 compileSdk 版本

设置

1、克隆仓库:

$ git clone https://github.com/bitwarden/android

2、在项目的根目录下创建一个 user.properties 文件,并添加以下属性:

  • gitHubToken:一个具有 read:packages 权限的「经典」 GitHub 个人访问令牌 (PAT)(例如:gitHubToken=gph_xx...xx)。这些令牌可以通过访问 生成。参阅了解更多详情。

  • localSdk:一个布尔值,用于确定是否应从本地 Maven 仓库加载 SDK(例如:localSdk=true)。这在开发新 SDK 时特别有用。查看了解更多详情。

3、设置代码风格格式化工具:

所有代码必须遵循以下指南中描述的 。为了帮助遵守这些规则,所有贡献者应将 docs/bitwarden-style.xml 作为他们的代码样式方案应用。在 IntelliJ / Android Studio 中:

  • 导航到 Preferences > Editor > Code Style 。

  • 点击 Scheme 旁边的 Manage 按钮。

  • 选择 Import。

  • 在项目的 docs/ 目录中找到 bitwarden-style.xml 文件。

  • 从 BitwardenStyle 导入到 BitwardenStyle。

  • 勾选 Enable EditorConfig support。

  • 点击 Apply 和 OK 保存更改然后退出 Preferences。

注意,在某些情况下,您可能需要重新启动 Android Studio 才能使更改生效。

所有代码在提交拉取请求之前都应格式化。这可以手动完成,但创建一个带有自定义键盘绑定的宏以在保存时自动格式化也是有帮助的。在 OS X 的 Android Studio 中:

  • 选择 Edit > Macros > Start Macro Recording

  • 选择 Code > Optimize Imports

  • 选择 Code > Reformat Code

  • 选择 File > Save All

  • 选择 Edit > Macros > Stop Macro Recording

这可以通过导航到 Android Studio > Preferences 并编辑 Keymap 下的宏来实现一组键(例如:shift + command + s)。

请避免在同一个提交/PR 中混合格式化和逻辑更改。如果可能,在提交逻辑更改之前,先在单独的 PR 中修复任何大的格式化问题。这有助于他人专注于代码审查时的有意义代码更改。

依赖

对于应用程序、开发环境和 CI/CD 依赖,请参阅 文件。

libs.versions.toml
官方页面地址
libs.versions.toml
GitHub 令牌页面
有关身份验证的 GitHub 包用户文档
代码样式指南文档
将 SDK 链接到客户端