初始化
This commit is contained in:
1
demo/mvvm/__init__.py
Normal file
1
demo/mvvm/__init__.py
Normal file
@@ -0,0 +1 @@
|
||||
"""MVVM demo 包:包含框架、模型、视图、视图模型和绑定逻辑。"""
|
||||
24
demo/mvvm/binder.py
Normal file
24
demo/mvvm/binder.py
Normal file
@@ -0,0 +1,24 @@
|
||||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
"""
|
||||
绑定层。
|
||||
|
||||
binder 的职责是把 View 和 ViewModel 连接起来:
|
||||
1. 把界面控件信号连接到 ViewModel 的事件函数。
|
||||
2. 把 Model 与 View 交给框架建立数据绑定。
|
||||
"""
|
||||
from mvvm.view_model import *
|
||||
from mvvm.view import *
|
||||
|
||||
|
||||
def binding_main_ui(ui: MainWinView, vm: MainWinVM):
|
||||
"""绑定主窗口 UI 与主窗口 ViewModel。"""
|
||||
|
||||
# 绑定 PyQt 控件事件:按钮点击后调用 ViewModel 中的业务方法。
|
||||
ui.YesBtn.clicked.connect(vm.event_log_yes)
|
||||
ui.NoBtn.clicked.connect(vm.event_log_no)
|
||||
|
||||
# 建立双向绑定。
|
||||
# 当前 demo 实际使用的是 Model -> View:model_log 改变后刷新 view_log。
|
||||
# 因为 view_log 没有主动发布事件,所以 View -> Model 方向暂时不会触发。
|
||||
fw_proxy.binding(vm.model_log, ui.view_log)
|
||||
210
demo/mvvm/framework.py
Normal file
210
demo/mvvm/framework.py
Normal file
@@ -0,0 +1,210 @@
|
||||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
"""
|
||||
MVVM 小框架核心模块。
|
||||
|
||||
这个文件实现了一个极简的“发布-订阅”事件通道,并在它之上封装
|
||||
Model 与 View 的绑定关系。demo 中的界面刷新不是由 ViewModel 直接
|
||||
调用 View 完成,而是由 Model 发布事件,再由订阅者 View 响应事件。
|
||||
"""
|
||||
from threading import Thread, Lock
|
||||
from queue import Queue
|
||||
from enum import Enum, unique
|
||||
|
||||
|
||||
class Subscriber(object):
|
||||
"""
|
||||
订阅者。
|
||||
|
||||
一个订阅者由两部分组成:
|
||||
1. topic:它关心的事件主题。
|
||||
2. callback:主题事件发生时要执行的回调函数。
|
||||
"""
|
||||
|
||||
def __init__(self, topic, callback):
|
||||
# 保存订阅主题,例如 "log_to_view"。
|
||||
self._topic = topic
|
||||
# 保存事件到来时要调用的函数,例如 view.signal_proxy。
|
||||
self._callback = callback
|
||||
|
||||
@property
|
||||
def topic(self):
|
||||
"""返回订阅者关注的主题。"""
|
||||
return self._topic
|
||||
|
||||
@property
|
||||
def callback(self):
|
||||
"""返回事件触发时要执行的回调函数。"""
|
||||
return self._callback
|
||||
|
||||
|
||||
class Publisher(object):
|
||||
"""
|
||||
发布者/事件对象。
|
||||
|
||||
这里的 Publisher 不是一个长期存在的对象,而是一次事件发布时
|
||||
放进队列里的消息包:topic 表示发给谁,content 表示传什么数据。
|
||||
"""
|
||||
|
||||
def __init__(self, topic, content):
|
||||
# 事件主题,决定这条消息会被哪些订阅者消费。
|
||||
self._topic = topic
|
||||
# 事件内容,也就是回调函数收到的参数。
|
||||
self._content = content
|
||||
|
||||
@property
|
||||
def topic(self):
|
||||
"""返回事件主题。"""
|
||||
return self._topic
|
||||
|
||||
@property
|
||||
def content(self):
|
||||
"""返回事件内容。"""
|
||||
return self._content
|
||||
|
||||
|
||||
# 保留主题:当前 demo 没有使用,可作为以后“不触发实际业务”的占位主题。
|
||||
KEEP_TOPIC = 'keep'
|
||||
|
||||
|
||||
class EventChannel(Thread):
|
||||
"""
|
||||
事件通道。
|
||||
|
||||
它继承 Thread,内部维护一个 Queue。发布事件时先把事件放入队列;
|
||||
线程运行后不断从队列取事件,再根据 topic 找到对应订阅者并执行回调。
|
||||
"""
|
||||
|
||||
def __init__(self):
|
||||
super(EventChannel, self).__init__()
|
||||
|
||||
# 控制事件循环是否继续运行。
|
||||
self._working = True
|
||||
# 保护订阅关系表,避免多个线程同时读写造成状态错乱。
|
||||
self._mutex = Lock()
|
||||
# 存放待处理事件的线程安全队列。
|
||||
self._queue = Queue()
|
||||
# 订阅关系表:{"topic": [Subscriber, Subscriber, ...]}。
|
||||
self._resigster_container = {}
|
||||
|
||||
def __del__(self):
|
||||
# 对象销毁时尝试停止循环。注意:如果线程正阻塞在 queue.get(),
|
||||
# 仅设置 False 不一定能立即退出,这里只作为简单 demo 处理。
|
||||
self._working = False
|
||||
|
||||
def run(self) -> None:
|
||||
"""线程入口:持续消费事件队列,并通知对应订阅者。"""
|
||||
while self._working:
|
||||
# Queue.get() 会阻塞等待新事件,因此线程不会空转占用 CPU。
|
||||
puber = self._queue.get()
|
||||
with self._mutex:
|
||||
print('pop event {} : {}'.format(puber.topic, puber.content))
|
||||
# 找到该 topic 下的所有订阅者;无人订阅时返回空列表。
|
||||
group = self._resigster_container.get(puber.topic, [])
|
||||
for suber in group:
|
||||
# 将事件内容传给订阅者的回调函数。
|
||||
suber.callback(puber.content)
|
||||
|
||||
def publish(self, topic: str, content):
|
||||
"""发布事件:把主题和内容包装成 Publisher 后放入队列。"""
|
||||
puber = Publisher(topic, content)
|
||||
self._queue.put(puber)
|
||||
|
||||
def subscribe(self, topic: str, callback):
|
||||
"""订阅事件:把某个 topic 与对应回调函数登记到订阅关系表中。"""
|
||||
suber = Subscriber(topic, callback)
|
||||
with self._mutex:
|
||||
group = self._resigster_container.get(suber.topic, [])
|
||||
group.append(suber)
|
||||
self._resigster_container[suber.topic] = group
|
||||
|
||||
|
||||
class BaseModel(object):
|
||||
"""
|
||||
Model 基类。
|
||||
|
||||
子类修改自身数据时,一般会通过 fw_proxy.channel.publish 发布事件;
|
||||
当 View 的事件反向更新 Model 时,则由 signal_proxy 接收新值。
|
||||
"""
|
||||
|
||||
def __init__(self, topic: str):
|
||||
# 每个 Model 都有自己的主题,用来向外通知“我变了”。
|
||||
self._topic = topic
|
||||
|
||||
@property
|
||||
def topic(self):
|
||||
"""返回 Model 对应的发布主题。"""
|
||||
return self._topic
|
||||
|
||||
def signal_proxy(self, *args):
|
||||
"""事件代理函数。子类通常会重写它来更新自身状态。"""
|
||||
print('{} event proxy run'.format(type(self)))
|
||||
|
||||
|
||||
class BaseView(object):
|
||||
"""
|
||||
View 基类。
|
||||
|
||||
View 负责界面显示。它收到 Model 发布的事件后,在 signal_proxy 中
|
||||
把数据刷新到具体控件上。
|
||||
"""
|
||||
|
||||
def __init__(self, topic: str):
|
||||
# 每个 View 也有自己的主题,做双向绑定时可用来通知 Model。
|
||||
self._topic = topic
|
||||
|
||||
@property
|
||||
def topic(self):
|
||||
"""返回 View 对应的发布主题。"""
|
||||
return self._topic
|
||||
|
||||
def signal_proxy(self, *args):
|
||||
"""事件代理函数。子类通常会重写它来刷新界面控件。"""
|
||||
print('{} event proxy run'.format(type(self)))
|
||||
|
||||
|
||||
@unique
|
||||
class BindingStyle(Enum):
|
||||
"""绑定方式枚举。"""
|
||||
|
||||
DOUBLE_BINDING = 0 # 双向绑定:Model -> View,同时 View -> Model。
|
||||
MODEL_TO_VIEW = 1 # 单向绑定:Model 改变后刷新 View。
|
||||
VIEW_TO_MODEL = 2 # 单向绑定:View 改变后更新 Model。
|
||||
|
||||
|
||||
class Framework(object):
|
||||
"""框架入口对象,负责启动事件通道并建立绑定关系。"""
|
||||
|
||||
def __init__(self):
|
||||
# 整个框架共用一个事件通道。
|
||||
self.channel = EventChannel()
|
||||
|
||||
def work(self):
|
||||
"""启动事件通道线程。"""
|
||||
# 设为守护线程:主程序退出时,该事件线程也会随之结束。
|
||||
self.channel.daemon = True
|
||||
self.channel.start()
|
||||
|
||||
def binding(self, model: BaseModel, view: BaseView, style=BindingStyle.DOUBLE_BINDING):
|
||||
"""
|
||||
建立 Model 与 View 的绑定。
|
||||
|
||||
本质是把某一方的 topic 订阅到另一方的 signal_proxy。
|
||||
"""
|
||||
if style == BindingStyle.DOUBLE_BINDING:
|
||||
# Model 发布变化时,View 响应并刷新界面。
|
||||
self.channel.subscribe(model.topic, view.signal_proxy)
|
||||
# View 发布变化时,Model 响应并更新数据。
|
||||
self.channel.subscribe(view.topic, model.signal_proxy)
|
||||
elif style == BindingStyle.MODEL_TO_VIEW:
|
||||
# 模型改变引起视图改变。
|
||||
self.channel.subscribe(model.topic, view.signal_proxy)
|
||||
elif style == BindingStyle.VIEW_TO_MODEL:
|
||||
# 视图改变引起模型改变。
|
||||
self.channel.subscribe(view.topic, model.signal_proxy)
|
||||
else:
|
||||
raise RuntimeWarning('binding is wrong')
|
||||
|
||||
|
||||
# 框架单例对象:其他模块通过 fw_proxy 使用同一个事件通道。
|
||||
fw_proxy = Framework()
|
||||
45
demo/mvvm/model.py
Normal file
45
demo/mvvm/model.py
Normal file
@@ -0,0 +1,45 @@
|
||||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
"""
|
||||
Model 层。
|
||||
|
||||
Model 负责保存业务数据。这个 demo 只有一个字符串模型 StringModel,
|
||||
它保存一条日志文本;当日志文本被修改时,会向事件通道发布通知。
|
||||
"""
|
||||
from mvvm.framework import fw_proxy, BaseModel
|
||||
|
||||
|
||||
class StringModel(BaseModel):
|
||||
"""字符串数据模型:保存一个字符串,并在值改变时发布事件。"""
|
||||
|
||||
def __init__(self, topic: str, value: str):
|
||||
# topic 用于告诉框架:这个 Model 的变化应该发布到哪个主题。
|
||||
super().__init__(topic)
|
||||
# 真正保存字符串值的私有变量。
|
||||
self._string = value
|
||||
|
||||
@property
|
||||
def value(self):
|
||||
"""读取当前字符串值。"""
|
||||
return self._string
|
||||
|
||||
@value.setter
|
||||
def value(self, value: str):
|
||||
"""
|
||||
修改字符串值。
|
||||
|
||||
这是 MVVM 自动刷新的关键位置:只要业务代码给 model.value 赋值,
|
||||
Model 就会发布事件,View 会在订阅到事件后自动刷新。
|
||||
"""
|
||||
self._string = value
|
||||
fw_proxy.channel.publish(self._topic, value)
|
||||
|
||||
def signal_proxy(self, value: str):
|
||||
"""
|
||||
接收 View 反向传来的值。
|
||||
|
||||
在双向绑定场景中,如果 View 发布了自己的变化,框架会调用这里,
|
||||
从而把 View 的新值同步回 Model。
|
||||
"""
|
||||
super().signal_proxy()
|
||||
self._string = value
|
||||
49
demo/mvvm/view.py
Normal file
49
demo/mvvm/view.py
Normal file
@@ -0,0 +1,49 @@
|
||||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
"""
|
||||
View 层。
|
||||
|
||||
View 负责界面控件的创建、显示和刷新。这里使用 PyQt5 的 QMainWindow
|
||||
作为主窗口,并把 QTextBrowser 包装成一个 LogView,方便接入 MVVM 绑定。
|
||||
"""
|
||||
from PyQt5.QtWidgets import *
|
||||
|
||||
from mvvm.framework import *
|
||||
from design import main_win
|
||||
|
||||
|
||||
class LogView(BaseView):
|
||||
"""日志视图:把收到的日志文本追加显示到 QTextBrowser 中。"""
|
||||
|
||||
def __init__(self, topic: str, browser: QTextBrowser):
|
||||
# topic 表示这个 View 自己发布变化时使用的主题。
|
||||
super().__init__(topic)
|
||||
# 保存真正负责显示日志的 PyQt 控件。
|
||||
self.browser = browser
|
||||
|
||||
def signal_proxy(self, log: str):
|
||||
"""
|
||||
接收 Model 发来的日志文本,并刷新界面。
|
||||
|
||||
在本 demo 中,StringModel.value 被修改后会发布 log 文本,
|
||||
框架事件通道最终会调用这个函数。
|
||||
"""
|
||||
super().signal_proxy()
|
||||
# 将新日志追加到文本浏览器。
|
||||
self.browser.append(log)
|
||||
# 文本框显示到底部,让用户总能看到最新日志。
|
||||
self.browser.moveCursor(self.browser.textCursor().End)
|
||||
|
||||
|
||||
class MainWinView(QMainWindow, main_win.Ui_MainWindow):
|
||||
"""主窗口 View:继承 Qt 主窗口和 Qt Designer 生成的界面类。"""
|
||||
|
||||
def __init__(self, parent=None):
|
||||
super(MainWinView, self).__init__(parent)
|
||||
# setupUi 会创建 LogBrowser、YesBtn、NoBtn 等控件。
|
||||
self.setupUi(self)
|
||||
# 设置窗口标题。
|
||||
self.setWindowTitle("log演示demo")
|
||||
|
||||
# 包装日志控件,让它成为可绑定的 View 对象。
|
||||
self.view_log = LogView('view_to_log', self.LogBrowser)
|
||||
26
demo/mvvm/view_model.py
Normal file
26
demo/mvvm/view_model.py
Normal file
@@ -0,0 +1,26 @@
|
||||
#!/usr/bin/python
|
||||
# -*- coding: utf-8 -*-
|
||||
"""
|
||||
ViewModel 层。
|
||||
|
||||
ViewModel 连接界面操作与业务数据:按钮点击后不直接操作界面,
|
||||
而是修改 Model;Model 再通过事件通道通知 View 刷新。
|
||||
"""
|
||||
from mvvm.model import *
|
||||
|
||||
|
||||
class MainWinVM(object):
|
||||
"""主窗口 ViewModel:保存主窗口需要的数据模型和按钮事件逻辑。"""
|
||||
|
||||
def __init__(self):
|
||||
# 创建日志内容 Model。
|
||||
# 主题 "log_to_view" 表示:这个 Model 的变化要通知日志 View。
|
||||
self.model_log = StringModel('log_to_view', '启动日志')
|
||||
|
||||
def event_log_yes(self):
|
||||
"""Yes 按钮点击事件:写入一条 yes 日志。"""
|
||||
self.model_log.value = 'log: yes!!!'
|
||||
|
||||
def event_log_no(self):
|
||||
"""No 按钮点击事件:写入一条 no 日志。"""
|
||||
self.model_log.value = 'log: no~~~'
|
||||
Reference in New Issue
Block a user