# Shield

**Repository Path**: mirrors_Meituan-Dianping/Shield

## Basic Information

- **Project Name**: Shield
- **Description**: A declarative, efficient, and flexible Native framework for building user interfaces. 
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2020-08-09
- **Last Updated**: 2026-03-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Shield

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/Meituan-Dianping/Shield/pulls)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/Meituan-Dianping/Shield/blob/master/LICENSE)

## 概述

`Shield`是一个模块化UI界面解决方案，它不仅仅是一个Native（Android&iOS）的UI开发框架，而是美团点评到店综合团队基于自身复杂的业务场景沉淀出来的UI开发最佳实践，它不但具备高可复用性，协同开发等特性，还包括后端动态配置，动态模块等一系列解决方案。

## 接入
在工程的`build.gradle`文件中添加依赖：
```
compile 'com.dianping.android.sdk:shieldCore:1.6.0'
```

## 设计思想

### 1.模块独立

模块具备完整的页面能力（生命周期，Context等），模块可以在不同的页面中自由组合，模块与页面高度解耦，模块不关心具体在哪个页面中运行。模块之间需要解耦，模块只关心自己涉及的状态和数据。

### 2.数据驱动
模块的表现只取决于所依赖的数据，而与具体的行为无关。

### 3.接口
整个模块化框架通过抽象接口进行交互，通过接口规范行为，通过接口的不同实现达到多态的目的

## 整体框架

一个典型的模块化页面主要由页面和多个模块构成。页面通过模块配置（Config）确定加载哪些模块构成页面。模块又分为业务逻辑（Agent）和视图逻辑部分（SectionCellInterface， 包括 Section 和 Row）。
页面包含两个管理器，模块管理器（AgentManager）和视图管理器（CellManager）。其中模块管理器决定了如何创建，更新，恢复及销毁模块以及如何将模块添加到页面中；
视图管理器则决定了页面使用何种视图容器管理视图以及模块中的视图组件（SectionCellInterface）如何添加到视图容器中。
除此之外，页面还持有一个支持数据订阅和通知的白板（WhiteBoard），用于模块与页面，模块与模块之间的数据交互。

## 接入
请参照Sample中的com.example.shield.fragments.AgentManagerFragment

另外：

1. 在onCreateView中构建页面容器ContentView。
2. 在onActivityCreated方法中调用setAgentContainerView方法设置模块容器。
3. 在getCellManager方法中指定页面使用何种CellManager（默认为SectionRecyclerCellManager,与RecyclerView容器配合使用）。
4. 在getAgentManager方法中指定页面使用何种AgentManager（默认为LightAgentManager，一般无需定制）。
5. 通过generaterDefaultConfigAgentList方法指定模块配置。

## 博客文章
[Shield——开源的移动端页面模块化开发框架](https://tech.meituan.com/shield_opensource.html)

## 技术支持
- 通过提交issue来寻求帮助
- 联系我们寻求帮助

## ChangeLog
[2018.3.12]
-   RecyclerView容器支持设置是否可以滚动
-   HeaderCell&FooterCell新增置顶置底支持
-   HeaderCell&FooterCell新增上下分割线完善
-   优化模块配置方式
-   优化模块曝光计算逻辑
-   Bug Fix

[2019.1.30]
- 基于Kotlin的全面重构
- 新的视图管理器ShieldNodeCellManager
- 新的生命周期路由ShieldLifeCycler
- 新的ShieldSectionCellItem视图层表达方式
- Bugfix

## 贡献代码
- 欢迎提交issue
- 欢迎提交PR

## LICENSE

Shield is [MIT licensed](https://github.com/Meituan-Dianping/Shield/blob/master/LICENSE)