Bridge Pattern

问题

• 什么是 Bridge Pattern (桥接模式) ？

• 为何要采用 Bridge Pattern？

• 工作中有哪些场景、库用到了 Bridge Pattern

介绍

什么是 Bridge Pattern

桥接模式是一种结构型设计模式， 可将一个大类或一系列紧密相关的类拆分为抽象和实现两个独立的层次结构， 从而能在开发时分别使用。

 

为何采用 Bridge Pattern

结构

如右图所示，一般 Bridge Pattern 可用此结构表示：

1. Abstraction: 抽象部分，提供面向用户操作的接口

2. Implementation: 实现系统的接口封装，提供一些方法，用于完成面向用户的复杂功能

3. Concrete Implementations: 具体的实现类，可实现平台特定、类型特定的代码

4. Refined Abstraction: 可在父类的基础上，重载原有的功能 or 提供更丰富的功能

5. Client: 客户代码，与 Abstraction 对象交互，使用其提供的功能

 

主要应用场景

• 面向复杂的、较大的系统，希望拆分系统为若干个独立的子系统

• 消除平台、系统差异化，对外提供统一的操作接口，如：
• 操作系统的差异：Linux Windows MacOS…
• 数据库类型差异：MySQL PostgreSQL SQLite…
• 文件类型的差异：Yaml Json Toml…
• ……

日常工作中的实践

• 常见的 orm 库 - 隐藏数据库类型差异:
• Python - SQLAlchemy
• Go - gorm

• Python logging 中 Logger Class 与 Handler 的关系

案例分析 - Python: Logger ↔ Handler

• 背景介绍
• Logger: 接收 log event，将其处理成 LogRecord 对象后，发送给 Handler or 父级 Logger 处理
• Handler: 接收来自Logger Class的LogRecord对象，通过emit()方法对日志做任何想做的事情 (yes, anything! )

• 如何应用 Bridge Pattern
• Logger 和 Handler 通过 Bridge Pattern 解耦成 2个互相独立的子系统
• Handler 演化举例：我想把 log 输出到……
• 控制台：StreamHandler
• 文件：FileHandler
• 邮件：SMTPHandler
• 不想要了：NullHandler
• …… 官方库中提供了许多预定义的 Handler，参见：python logging.handlers
• 其他自定义的需求（Anything）均可通过自定义 Handler 完成

• pytest-reportportal插件中的应用
需求 / 功能
• 日志可携带附件，可上传文件、图片等
• 日志通过 API 上传到 RP Server
rp_logging.RPLogger
• 重载 _log() 方法，将附件存入 LogRecord 对象
• code: https://git.wosai-inc.com/qa/agent-python-pytest/-/blob/master/pytest_reportportal/rp_logging.py#L49
rp_logging.RPHandler
• 重载 emit() 方法，解析logRecord.extra信息；调用 API 完成日志上报
• code: https://git.wosai-inc.com/qa/agent-python-pytest/-/blob/master/pytest_reportportal/rp_logging.py#L150

案例分析 - Havok: Fetcher ↔ Analyzer

• 全链路压测工具 Havok 中使用了 Bridge Pattern 来解耦 Fetcher 和 Analyzer

• 背景介绍



• Fetcher: 负责对日志数据的索引以及反序列化（LogRecord）
• Analyzer: 日志分析器，是Fetcher的组件之一，用于将采集的单行日志[]byte反序列化成LogRecordWrapper对象

classDiagram 
	direction TD
	
	baseFetcher <|-- fileFetcher
	baseFetcher <|-- SLSFetcher
	baseFetcher: - Analyzer analyzer
	baseFetcher: + Start()
	baseFetcher: + WithAnalyser()

	Analyzer <|-- BaseAnalyzer
	Analyzer <|-- QrWapPayAnalyzer
	Analyzer <|-- UpayGatewayAnalyzer
	
	baseFetcher o-- Analyzer
	

	class fileFetcher{
		+ Start()
	}
	class SLSFetcher{
		+ Start()
	}
	class Analyzer{
		+ Use()
		+ Analyze()
	}
	class BaseAnalyzer{
		- analysers
		+ Use()
		+ Analyze()
	}
	class QrWapPayAnalyzer{
		+ Analyze()
	}
	class UpayGatewayAnalyzer{
		+ Analyze()
	}

问题讨论

Adapter (适配器) VS Bridge

参考资料

Python Logging: An In-Depth Tutorial | Toptal®

The Python logging module comes with the standard library and provides basic logging features. By setting it up correctly, a log message can bring a lot of useful information about when and where the log is fired as well as the log context such as the running process/thread.

https://www.toptal.com/python/in-depth-python-logging

Bridge

Bridge is a structural design pattern that lets you split a large class or a set of closely related classes into two separate hierarchies—abstraction and implementation—which can be developed independently of each other.

https://refactoring.guru/design-patterns/bridge

havok/README.md at master · WoSai/havok

Contribute to WoSai/havok development by creating an account on GitHub.

https://github.com/WoSai/havok/blob/master/README.md

logging — Logging facility for Python

Source code: Lib/logging/__init__.py Important: This page contains the API reference information. For tutorial information and discussion of more advanced topics, see Basic Tutorial, Advanced Tutor...

https://docs.python.org/3/library/logging.html#handler-objects