MySQL Workbench on 学少何Blog

MySQL Workbench 的 Data Export 无法使用的问题即解决方案

Wed, 02 Sep 2026 09:35:39 +0800

现象

在一个暖阳照射下的悠闲下午，打开了 MySQL Workbench，准备把现在的数据库手动导出一份做备份。熟练的点开 Server -> Data Export，结果出现的界面却是一片空白，点击 Advanced Options还会弹出报错。

提示去看下日志，结果只有下面这段看起来莫名奇妙的日志：

17:36:30 [ERR][wb_admin_export.py:get_mysqldump_version:113]: Error retrieving version from C:\Program Files\MySQL\MySQL Server 8.0\bin\mysqldump.exe:
(exit 0)Exception activating the page - '<' not supported between instances of 'NoneType' and 'str'Error retrieving version from C:\Program Files\MySQL\MySQL Server 8.0\bin\mysqldump.exe:
(exit 0)Exception activating the page - '<' not supported between instances of 'NoneType' and 'str'Unhandled exception in Python code:
Traceback (most recent call last):
File "C:\Program Files\MySQL\MySQL Workbench 8.0\modules\wb_admin_export.py", line 2333, in show_options
self.options_tab.show(True)
^^^^^^^^^^^^^^^^
AttributeError: 'WbAdminExport' object has no attribute 'options_tab'

然后去问了下 AI，只是告诉我，没有配置正确的 mysqldump.exe 的路径，或者是直接用 mysqldump -u root -p 数据库名 > 备份文件.sql。

解决

由于还是希望使用 UI 界面，所以还是尝试去解决了一下。原因后面会解释。

首先找到 MySQL Workbench 的软件目录，比如我这里是 C:\Program Files\MySQL\MySQL Workbench 8.0。

在目录下，有一个 modules 文件夹，进入这个文件夹。

在 modules 文件夹中，找到 wb_admin_export.py 这个文件，用你常用的编辑器打开它。

然后找到 109 行，可以看到下面这段代码：

rc = local_run_cmd('"%s" --version' % path, output_handler=output.write)

把 version 改成 help，然后保存。修改完成的代码如下：

rc = local_run_cmd('"%s" --help' % path, output_handler=output.write)

最后，如果启动了 Workbench，先关掉，然后再启动。

之后点开 Data Export 就没有问题了。

原因

排查问题原因，首先是上面的那段报错日志。根据报错日志我们可以定位到 wb_admin_export.py 的 113 行。

 if rc or not output:
 log_error("Error retrieving version from %s:\n%s (exit %s)"%(path, output, rc))
 return None

但是这一行只是输出日志的，并不是问题出现的地方。

看到 if 条件，大致可以判断出，执行 mysqldump.exe --version 获取到的输出有问题。

先在命令行尝试一下这个命令，先判断下是不是没有配置环境变量，导致输出为空了。

PS C:\> mysqldump.exe --version
mysqldump Ver 8.0.45 for Win64 on x86_64 (MySQL Community Server - GPL)
PS C:\>

像我这边是配置好了，所以有输出版本。

那就很奇怪了，明明 mysqldump 能运行，并且有输出，为什么会报错？

如果把这个丢给 AI，它大概率会回复，可能是没有配置环境变量，或者是 Workbench 没有配置 mysqldump 的路径。然后如果让它修复这段代码，它可能会怀疑 mysqldump --version 并没有输出到 stdout（即标准输出流），并且会尝试去获取 stderr（即标准错误流）。

但其实如果尝试过 mysqldump --version > out.txt 就会发现，out.txt 文件里的内容是空的。也就是说，输出到控制台上的内容，根本不是标准输出流里的。

后面我甚至尝试了使用 Python 和 C# 自己写代码，去获取其输出，结果无论是 stdout 还是 stderr 都是空的。

其实根本原因也无法明了，但是在这种情况下，我首先是采取了 AI 的思路，把 return None 改为返回一个默认的版本，代码变成了下面这样：

 if rc or not output:
 log_error("Error retrieving version from %s:\n%s (exit %s)"%(path, output, rc))
 return Version(8, 0, 45)

但这样不太合适，如果版本一致还好，版本不一致可能会出问题。只能说在版本不变的情况下，可以稳定使用。

最好的方式肯定还是获取 mysqldump.exe 的版本。

这时候一种必定可行的思路，读取可执行文件中，文件信息附带的版本号。

这样就需要在 Workbench 中去配置 mysqldump 的绝对路径，而且对于 wb_admin_export.py 的改动很大。

也是巧合，我在思考如果这样，直接使用命令行其实也行，所以项先看看 mysqldump 有哪些命令可以用，所以使用 --help 去查看。

结果发现帮助的输出的第一行，居然有一模一样的版本输出。

然后试着把打印的内容输出到文件里，也成功了。所以试着去把代码里的 --version 改成了 --help，试了下 Data Export，能正常使用了。

不过到最后，其实也没有弄明白 mysqldump --version 究竟是什么原理，可以正常输出控制台，但是输出无法输出到文件，其他程序去调用也没有办法去获取。

当然这个可能也和电脑环境有关系，比如公司电脑需要安装的加密软件，又或者是电脑中安装的其他东西，影响到了这个地方。

总之，记录下这个情况，以后再遇到就不必费事费力了。

使用 ConfuserEX2 加密混淆 C# 程序

Thu, 05 Jun 2025 10:19:57 +0800

为什么需要对 C# 程序进行混淆和加密

通常需要这样做大多是因为商业项目。

就我个人情况而言，目前是在为一个公司使用的软件编写插件，有外发需求，所以需要对插件进行代码加密。

快速使用

目前我用得最舒适的方式是将 ConfuserEx 集成到项目中，并在编译的同时进行加密操作。

ConfuserEx 的生成操作为，在项目构建完成之后，会将指定的文件进行加密，并根据配置来决定是否替换掉原文件。

使用前

ConfuserEx2 推荐去 Github 的 Release 界面下载一个最新的 GUI 工具，方便管理和添加加密规则。

初始化加密

对于新建或者已有的 C# 项目，可以通过 Visual Studio 的包管理，或者通过 nuget 包管理器添加 ConfuserEx 的 MSBuild 包。

dotnet add package Confuser.MSBuild --version 1.6.0

然后打开 ConfuserEx 的 GUI 工具，点击加号添加一个需要加密的文件，可以是 DLL 也可以是 EXE。当然，这个文件最好是单独的一个项目生成的文件。

比如此处我的项目是 Less.Utils，所以我添加了 Less.Utils.dll 文件。

然后在 Settings 选项卡中，找到刚才添加的文件，然后点击右侧的加号添加一个加密规则。再点击编辑图标修改规则。

Preset 是预设，建议选择 None，如果是加密应用程序可以按照需要选择。

点击在 Protection 下方右侧的加号即可添加一个加密规则。加密规则可以有很多个可以选择。

目前 ConfuserEx 支持的规则有（描述都为机翻）：

Anti Debug：此保护可防止对程序集进行调试或分析。
Anti Dump：此保护可防止从内存中转储程序集。
Anti IL Dasm：此保护使用阻止 ILDasm 反汇编的属性标记模块。
Anti Tamper：此保护可确保应用程序的完整性。
Constants：此保护对代码中的常量进行编码和压缩。
Control Flow：此保护会破坏方法中的代码，以便反编译器无法反编译方法。
Protection Hardening：此组件改进了保护代码，使其更难绕过它。
Invalid Metadata：此保护将无效的元数据添加到模块中，以防止反汇编器/反编译器打开它们。
Resources：此保护对嵌入的资源进行编码和压缩。
Type Scrambler：将类型替换为泛型。
Name：此保护会混淆符号的名称，因此既不能编译也不能读取反编译的源代码。
Watermarking：这会将水印应用于程序集，表明 ConfuserEx 保护了程序集。所以人们试图扭转混淆，知道放弃。

对于类库的加密，目前个人添加的是 Anti Dump、Anti IL Dasm、Anti Tamper、Constants、Control Flow 这 5 项。

添加完成后，点击工具栏的 Save Project，保存到项目的根目录下，文件命名和项目名需要一致。

项目设置

加密会影响调试，所以首选需要设置在 Release 模式下才进行加密。

双击项目打开项目文件，在文件中添加下面的内容：

<PropertyGroup Condition="'$(Configuration)' == 'Release'">
 <Obfuscate>true</Obfuscate>
 <ConfuserReplaceOutput>true</ConfuserReplaceOutput>
</PropertyGroup>

这几行配置了在 Release 模式下启用加密，并替换掉原来的文件。

然后打开刚才保存的加密配置文件，文件名为 <项目名>.crproj。如果在 VS 中不存在，可以通过右键项目，添加现有项来添加。

打开之后，将路径替换为 $(Output)，修改后保存。

<project outputDir="$(Output)\Confused" baseDir="$(Output)" xmlns="http://confuser.codeplex.com">
 <module path="Less.Utils.dll">
 <rule pattern="true" inherit="false">
 <protection id="anti dump" />
 <protection id="anti ildasm" />
 <protection id="anti tamper" />
 <protection id="constants" />
 <protection id="ctrl flow" />
 </rule>
 </module>
</project>

这样，加密配置就完成了。现在在 Release 模式下编译的生成的文件，就会应用上面的加密规则。

市面上的加密工具

Dotfuscator

可以直接使用 Visual Studio Installer，在其单个组件中找到并安装。安装之后在 Visual Studio 中使用功能搜索 dot，就能够使用了。相对来说使用方便，但是免费版加密程度有限，而且在我实际使用时，加密后的插件无法正常使用，所以不太推荐。

不过如果是加密应用程序，应该还是没有问题的。

Agile.NET

Agile.NET 是一个商业的加密工具，功能强大，但是需要付费，而且价格不便宜。

不过效果确实看着不错，加密后的代码公开方法和类型都能够正常用 ILSpy 和 dnSpy 查看，只是方法体全被去掉了。

结界.NET

结界.NET 是开源的命令行加密工具，同时也有 GUI 界面。使用方法可以看一下这个博客 -> 【JIEJIE.NET - 强大的 .NET 代码混淆工具】

不过这个加密工具同样是不推荐对类库进行加密，个人只推荐加密应用程序。

ConfuserEX2

ConfuserEx2，也是原作者停止更新后，社区其他开发者接手更新的项目。目前没有继续发布新的稳定版本了，但是还在继续更新。

这个工具除了 GUI 的界面，还有对应的 nuget 包 Confuser.MSBuild，能够在项目编译的同时进行加密操作。

就个人目前使用体验而言，这个是用起来最无感且最方便的。

一些反编译工具

ILSpy
dnSpy(Ex) 这个是原作者停止维护后，其他开发者接手并持续更新的项目

dnSpy 可以修改并重新编译程序和 DLL 文件，相对来说功能更强大。

如何初始化 llvm-sys

Sat, 23 Nov 2024 14:37:14 +0800

导入 llvm-sys库

添加 crate llvm-sys 到现有的项目中。

cargo add llvm-sys

如果有指定 llvm 版本需求，可以指定版本，比如版本 18.1.x 的 LLVM，可以指定 llmv-sys 的版本为 180。

目前最新版本支持到了 190，即当前最新版本 19.1.0 的 LLVM。

编译问题

如果试用 rust-analyzer 或运行命令 cargo check，会提示一个错误。

D:\Projects\rust\test-project>cargo check
warning: unused manifest key: worksapce
 Compiling llvm-sys v191.0.0
error: No suitable version of LLVM was found system-wide or pointed
 to by LLVM_SYS_191_PREFIX.

 Consider using `llvmenv` to compile an appropriate copy of LLVM, and
 refer to the llvm-sys documentation for more information.

 llvm-sys: https://crates.io/crates/llvm-sys
 llvmenv: https://crates.io/crates/llvmenv
 --> C:\Users\studylessshape\.cargo\registry\src\rsproxy.cn-0dccff568467c15b\llvm-sys-191.0.0\src/lib.rs:529:1
 |
529 | / std::compile_error!(concat!(
530 | | "No suitable version of LLVM was found system-wide or pointed
531 | | to by LLVM_SYS_",
532 | | env!("CARGO_PKG_VERSION_MAJOR"),
... |
539 | | llvmenv: https://crates.io/crates/llvmenv"
540 | | ));
 | |__^

error: could not compile `llvm-sys` (lib) due to 1 previous error

这是在提示需要为 LLVM_SYS_191_PREFIX 指定正确的 LLVM 路径。

下载安装 LLVM

信息

Linux 直接使用包管理器安装 LLVM，在安装完成后，试着输入命令 llvm-config，如果打印出了使用帮助信息，则可以不需要这一节的内容。

进入 LLVM 的官网 https://llvm.org/，点击左侧的 All Releases，或者直接进入 https://releases.llvm.org/。

找到自己需要的版本，并点击 Download。

目前的本人尝试下载的两个版本，都将下载地址放到了 github 上，而不是其官方网站了。

在 github release 中下载需要注意，不要下载 win32.exe 或 win64.exe，因为这两个执行文件的是安装包，安装好的 bin 文件夹下没有 llvm-config 程序。以 19.1.0 为例，需要下载下方的 LLVM-19.1.0-Windows-X64.tar.xz 文件。文件很大，所以如果下载不下来需要魔法才行，或者尝试去寻找并使用 github 文件下载加速站。

下载好之后，将压缩包解压出来，建议路径中最好没有空格和非英文字母的字符。

解压好之后，可以直接在 bin 文件夹下看一下有没有 llvm-config.exe，确认好之后就需要配置环境变量了。

设置环境变量

根据提示，可以在控制台中设置临时变量。设置好之后运行 cargo check。

set LLVM_SYS_191_PREFIX=D:\\Programs\\LLVM
cargo check

如果还出现了编译错误，并且与上面提到的问题一致，则可能需要重启一下控制台、IDE 或者系统。

也可以设置到系统的环境变量里。

没问题时，cargo check 应该会有如下输出：

注释

如果出现了类似于 cl.exe did not execute successfully 的错误，可能是使用了 LLVM 的安装包安装，并且直接将原来的安装目录下的文件，替换为了下载好的完整 LLVM 包里的文件，或者是路径中包含了空格。

Archlinux 安装笔记

Thu, 06 Jun 2024 10:33:09 +0800

前言

在 618 期间买了台新电脑，因为很早之前就想试试直接在电脑上而不是虚拟机里使用 Linux 系统，所以尝试着给旧电脑安装 Archlinux，原因有两点：

Archlinux 自由度高
因为有 archinstall，目前的安装 Archlinux 已经非常简单了。

另外这台旧电脑准备送给家人用，Linux 不太方便的安装软件方式，可以杜绝调很多安全问题。

旧电脑为华硕（ASUS）的飞行堡垒5。

CPU: Intel(R) Core(TM) i5-8300H CPU @ 2.30GHz
显卡: NVIDIA GeForce GTX 1050Ti
内存: 16GB Samsung 2667MHz （内存曾经自己加了一个 8GB 的）
主板: ASUSTek COMPUTER INC. FX505GE

用到的网站

Archlinux 官网

下载 Archlinux 镜像
rufus

镜像安装引导盘制作
官方安装教程（中文翻译）
Archlinux 简明指南

包含安装教程，和一些常用软件、工具的安装
RsProxy

目前使用过最快的国内 Rust 镜像
paru

AUR 软件包安装助手
AUR

archlinux 的 aur 仓库网页，搜索需要的软件包很方便，官方直接支持的软件包可以点开 Home 旁边的 packages 查看

下载镜像

进入 Archlinux 官网，点击导航栏最右侧的 Download，然后下载 torrent 文件，使用自己常用的种子下载工具下载镜像即可。

直接使用磁力链接也可以，但是部分时候磁力链接可能加载不了下载列表。

Archlinux 的镜像文件相对来说比较小。写这篇博客时，下载的版本是 archlinux-2024.06.01-x86_64。

启动盘制作

此处我使用 rufus，当然其他制作工具也是可以的。

！！！制作启动盘前，请将 U 盘内的重要数据进行备份！！！

插入一个 U 盘，然后打开 rufus，分区类型选择 GPT，目标系统类型选择 UEFI，然后点击开始。

U 盘会先被格式化，然后 rufus 会写入系统镜像。

BIOS 设置

在 BIOS 设置里关闭安全启动，不同的主板可能 BIOS 界面有所区别。

启动安装引导

此处需要根据不同的主板来进行操作，比如华硕的主板，出现 ASUS Logo 时长按 ESC 键，然后选择 USB 启动即可。

因为电脑已经寄走了，所以之后的安装画面都会使用虚拟机。

安装选择版本选择 x86_64 即可，也可根据自己电脑的实际情况选择。

出现上图的样子，就是成功进入了安装界面了。

检查网络

在进入安装界面的上面，有这样一段话：

输入 iwctl 可以进入无线网络的连接程序。输入 help 指令可以获取帮助。

Wlan 联网可以参考简明指南的连接网络章节。

因为有线网能直接检测到，所以我选择的方法是直连随身 WIFI 或者通过手机的 USB 来共享网络。

检查磁盘

这一步的目的是为了清空磁盘。如果需要重装 Archlinux，这一步比较关键。

在重装 Archlinux 时，如果不预先删掉分区，archinstall 的磁盘选项里，通过建议创建的分区后，不会删掉原来的分区，安装报错并中断。

！！！清空磁盘前，请确认磁盘的重要数据已经备份！！！

输入 fdisk -l，查看自己的磁盘。

上面显示的有两个磁盘，其中 /dev/sda 是我现在的磁盘。

如果有分区，即上面的命令有 /dev/sda1、/dev/sda2，建议输入 fdisk /dev/sda，进入磁盘管理控制台。然后输入 d + 回车删除分区，多个分区需要多次 d 指令。

电脑如果有两个磁盘，或者只有一个磁盘但是已经安装了 Windows 系统，可能会导致 archinstall 无法找到该磁盘，但是 fdisk 能够列出该磁盘，所以可能需要同样的方式删除磁盘分区（待验证）。

安装

网络和磁盘配置好之后，可以键入 archinstall + 回车，来安装 Archlinux 了。

如果一直卡在 Check version，可以使用 Ctrl + C 先终止安装，再输入 archinstall --skip-version-check 来禁止版本检查。

进入 archinstall 的页面如上所示。

Archinstall language 不作修改，点击 ↓ 或 j 选择 Mirrors，回车进入后选择 Mirror region 并回车。等待一小会儿之后，键入 /china，搜索国内镜像，并回车选择。

按 j 到 ← Back 并回车。进入 Locales 设置，需要更改的是 Locale language，进入后，选择 zh-cn.UTF8。

然后是磁盘配置。直接使用建议配置就行，因为之前已经做了删除分区的操作，所以执行安装时应该不会出错了。磁盘格式可以按自己需要选择，此处选择 btrfs。

主机名可以按需求更改，此处不变。

Root Password 即 root 用户密码，建议设置一个。User account 里，设置一个用户，是否有 sudo 权限可以根据自己需要来，为了方便我设置了 sudo 权限。

Profiles 选择桌面类型，当然如果是有其他需要，也可以不直接通过 archinstall 安装桌面环境。桌面环境挺多的，具体可以在分类:桌面环境查看，此处选择 Kde Plasma。

Audio 可以 No audio server，但还是建议随意选一个。

Kernels 即内核，建议多选择一个 linux-zen，方便之后安装 waydroid 并运行安卓应用。

Network configuration 建议如果选择安装了桌面环境，就使用 Use NetworkManager，这样可以使有无线网卡的主板，连接 WIFI。

Timezone 选择上海。

最终的配置如下所示。

选择 Install，然后回车，Archlinux 就正式开始安装了。安装过程中尽量保证网络畅通。

经过一段时间的等待，安装便完成了，会提示是否进入控制界面，选择进入。

Archlinux 没有自带中文字体，所以使用 pacman 安装一下中文字体：

pacman -S noto-fonts-cjk

安装完成后，输入 exit 退出 chroot 模式，然后输入 poweroff 关机，将 U 盘拔掉，再开机。

配置系统

再次启动后，会进入到 ssdm 的启动页，如下所示，说明我们已经成功安装了 Archlinux，接下来就是配置系统的时候了。

如果觉得当前的启动页与 Kde 的风格不符合，可以进入 系统设置->颜色和主题->登录屏幕(ssdm)，选择 Breeze 微风并应用即可。

输入密码进入桌面，我们依次打开 左下角菜单->系统->Konsole 终端。

因为在 archinstall 中，已经修改了镜像地区，所以后续使用 pacman 或 paru 时，并不需要修改地区。如果出现安装卡住，大部分时候是因为 aur 上软件包安装文件的指定服务器，国内无法访问或者访问过慢。

安装浏览器

首先需要安装的是浏览器，火狐其实就很不错，输入下面的命令安装火狐浏览器：

sudo pacman -S firefox

输入密码和 y 并回车继续安装。

安装 paru

安装 git 和 rustup：

sudo pacman -S git rustup

打开浏览器，在地址栏输入 http://rsproxy.cn/ 或者输入 rsproxy 并搜索，进入 rsproxy 的网站。按照教程修改 .bashrc，然后输入下面的命令安装 rust：

rustup install stable

安装完成之后，按照 rsproxy 的教程，修改 ~/.cargo/config 或 ~/.cargo/config.toml 的内容。

修改文件内容时，可能会出现找不到 vi 指令，这是因为 Archlinux 不会默认将 vim 指定 vi 别称。

打开 paru 的 github 仓库，找到 Install 出，复制下面的命名开始安装 paru。

sudo pacman -S --needed base-devel
git clone https://aur.archlinux.org/paru.git
cd paru
makepkg -si

安装输入法

输入法选择安装 fcitx5，即小企鹅 5。输入下面的命令安装输入法所需的所有软件包：

paru -S fcitx5-im fcitx5-chinese-addons

除了 fcitx5-chinese-addons，也可以查看 fcitx5 的 archlinux 页面，安装其他中文输入法组件。同时可以寻找想要安装的词库、皮肤或其他组件，也可以去搜索引擎中搜索。

安装全部内容完成之后，进入系统设置。打开键盘->虚拟键盘，选择 Fcitx5 并应用。应用之后会提示是否启用云拼音，可以根据自己需要选择。

现在在可以输入的地方按下 Ctrl + Space，就可以看到光标旁的 en 变成了 拼，就可以输入中文了，同时也可以再次按下 Ctrl + Space 切换回英文输入。

配置输入法（可选）

返回系统设置，找到区域和语言，选择输入法。点击配置全局选项，将 切换启用/禁用输入法 的快捷键修改为自己习惯的按键，此处我修改成了 Shift 键。

修改好后，应用并返回，找到 配置附加组件...->经典用户界面，往下翻找到 主题，在这里可以修改输入法的主题。

安装 QQ（安装示例）

QQ 的安装比较典型，因为 QQ 在安装之后无法正常使用输入法。

安装 QQ 可以使用下面的命令：

paru -S linuxqq

执行时会提示有几个不同的软件包：

不确定的话，可以上 Aur 上搜索 linuxqq，看看几个软件包有什么区别：

QQ 在之前发布过 NT 版，支持多平台。而在 Aur 上，linuxqq 被标记过期，那么其实最好是选择其他的软件包安装。其中 linuxqq-nt-bwrap 和 linuxqq-appimage 任选其中一个安装即可。此处选择 2，即 linuxqq-appimage。

安装完成，打开并登录 QQ，此时如果想发消息，会发现切换不了输入法。

退出 QQ，打开左下角菜单，找到 QQ，右键->编辑应用程序...->应用程序(A)，看到参数一栏，在后面添加下面的参数：

--enable-features=UseOzonePlatform --ozone-platform=wayland --enable-wayland-ime

然后就可以正常使用输入法了。

结束

剩下的都可以自己慢慢摸索了。

想要的软件包可以在 Packages - Archlinux 和 Aur 上安装，Kde 社区的软件可以上 Kde 应用软件官网上查找。

也可以看看 Archlinux 简明指南和 Archlinux wiki（Archlinux 中文维基）。

ItemsControl 组件的 Item 获取自己的 Index

Fri, 23 Feb 2024 20:47:28 +0800

目的

该功能的目的是为了获取 Item 自身的 Index，并可以绑定到数据模板中。

创建项目

创建一个 WPF 应用程序项目，并添加下面的依赖

MaterialDesignThemes

注意按照 Getting Start 来配置主题

添加 ItemsControl

将 Grid 分为两列，左列添加一个 ItemsControl，并将 ItemsControl.ItemsPanel 中 ItemsPanelTemplate 的内容设置为 WarpPanel，这样，子元素就能够自己排列了。同时将 ItemsControl.ItemTemplate 的模板设置为 DataTemplate。

现在的代码应该和下面一样，设计器中应该可以看见 Grid 已经被分成两列了。

<Grid>
 <Grid.ColumnDefinitions>
 <ColumnDefinition/>
 <ColumnDefinition/>
 </Grid.ColumnDefinitions>
 <ItemsControl>
 <ItemsControl.ItemsPanel>
 <ItemsPanelTemplate>
 <WrapPanel/>
 </ItemsPanelTemplate>
 </ItemsControl.ItemsPanel>
 <ItemsControl.ItemTemplate>
 <DataTemplate>
 </DataTemplate>
 </ItemsControl.ItemTemplate>
 </ItemsControl>
</Grid>

这个 ItemsControl 所需要做的功能，除了显示每个 Item 自身的 Index，我还希望能够选中并显示到第二列中。

在 MaterialDesignThemes 的 DemoApp 中，目录中有一栏叫 Chips，用来做为子控件感觉还不错，复制 Filter Chips 中的代码，添加到 DataTemplate 中。

把复制过来的代码中的 Content 删除，并将 TextBlock 填入 Content 中，Text 的内容暂时保留。代码应该如下所示：

<ItemsControl>
 <ItemsControl.ItemsPanel>
 <ItemsPanelTemplate>
 <WrapPanel />
 </ItemsPanelTemplate>
 </ItemsControl.ItemsPanel>
 <ItemsControl.ItemTemplate>
 <DataTemplate>
 <CheckBox IsChecked="True"
 Style="{StaticResource MaterialDesignFilterChipPrimaryOutlineCheckBox}">
 <TextBlock />
 </CheckBox>
 </DataTemplate>
 </ItemsControl.ItemTemplate>
</ItemsControl>

现在还没有东西显示出来，为了能够显示一点东西，先为 ItemsControl 添加一个硬编码的 ItemSource。

为了添加的内容较为简单，直接用数组即可，元素则使用字符串。为了使用基本类型，首先需要将 System 命名空间添加到 XAML 当中，此处将其引入名称指定为 sys。

<Window x:Class="IndexWithItemsControl.MainWindow"
 [...]
 xmlns:sys="clr-namespace:System;assembly=mscorlib"
 [...]>
 <Grid[...]>
</Window>

接下来为 ItemsControl 添加硬编码的 ItemSource。数组使用 x:Array 标记，字符串我们使用 sys:String 标记。

随便添加一点元素就行。我的代码如下，简单的添加了三个 String。

<ItemsControl>
 <ItemsControl.ItemsSource>
 <x:Array Type="{x:Type sys:String}">
 <sys:String>a</sys:String>
 <sys:String>b</sys:String>
 <sys:String>c</sys:String>
 </x:Array>
 </ItemsControl.ItemsSource>
 <ItemsControl.ItemsPanel[...]>
 <ItemsControl.ItemTemplate[...]>
</ItemsControl>

这时候已经能看到设计器上面有三个 Chips 按钮了。

添加 Converter 来获取 Index

为了获取 Index，我们需要找一下 ItemsControl 的文档，但是里面好像并没有想要的东西。

不过有一个属性比较令人在意，叫 ItemContainerGenerator。

点开这个属性的类型 ItemContainerGenerator 类看看，发现里面有一个函数叫做 IndexFromContainer。

稍微理一下，首先是 ItemsControl 中有一个 ItemContainerGenerator，每当 ItemsControl 的 ItemSource 更新时，应该会通过这个 Generator 来生成 UI。

那么现在通过 IndexFromContainer 这个函数，我们应该就可以拿到 Item 对应控件的 Index 了，这个 Index 同样也是 Item 的 Index。但是有一个问题是，这个传入的参数，即当前 Item 对应控件，该如何获取？

回到 Visual Studio 的项目。我们为 TextBlock 加一个绑定，但是特殊的是这个绑定只写一个语法，并不指定其他的东西，甚至是 Path。

<ItemsControl.ItemTemplate>
 <DataTemplate>
 <CheckBox IsChecked="True"
 Style="{StaticResource MaterialDesignFilterChipPrimaryOutlineCheckBox}">
 <TextBlock Text="{Binding}"/>
 </CheckBox>
 </DataTemplate>
</ItemsControl.ItemTemplate>

看向设计器，一个令人兴奋的效果出现了，我们数组中的元素出现在了 Text 中。

有这么个想法产生了，如果我们获取 DataTemplate 或者 CheckBox 控件，但是不指定其 Path 来绑定，那么传入的不就是控件自身了吗？

为了调用 IndexFromContainer 函数，还需要获得 ItemsControl 的 ItemContainerGenerator。所以需要用到 MultiBinding，这个绑定和 Binding 的区别在于，它可以绑定多个数据。

那么事不宜迟，开始为 TextBlock 来进行 MultiBinding。其中的 Binding，分别绑定 ItemsControl 的 ItemContainerGenerator 和当前控件。

<TextBlock>
 <TextBlock.Text>
 <MultiBinding>
 <Binding RelativeSource="{RelativeSource Mode=FindAncestor,AncestorType=ItemsControl}"></Binding>
 <Binding RelativeSource="{RelativeSource Mode=FindAncestor,AncestorType=CheckBox}"></Binding>
 </MultiBinding>
 </TextBlock.Text>
</TextBlock>

不过绑定失败了，提示我们需要一个 MultiConverter，而且我们发现我们虽然拿到了控件，但是并不能运行需要的函数。

为了先使绑定成功，先新建一个 Converter，类的名字命名为 IndexOfItemsControlConverter。类的内容应如下所示。

using System;
using System.Globalization;
using System.Windows.Data;

namespace IndexWithItemsControl.Converters
{
 public class IndexOfItemsControlConverter : IMultiValueConverter
 {
 public object Convert(object[] values, Type targetType, object parameter, CultureInfo culture)
 {
 throw new NotImplementedException();
 }

 public object[] ConvertBack(object value, Type[] targetTypes, object parameter, CultureInfo culture)
 {
 throw new NotImplementedException();
 }
 }
}

为 Converter 实现了 IMultiValueConverter 接口，这样就可以让 MultiBinding 使用此 Converter。

Converter 的使用可以查看如何：转换绑定的数据

我们可以将返回值直接返回 values，并在 Convert 函数的 return 处打上断点。

public object Convert(object[] values, Type targetType, object parameter, CultureInfo culture)
{
 return values;
}

public object[] ConvertBack(object value, Type[] targetTypes, object parameter, CultureInfo culture)
{
 if (value is object[] list)
 {
 return list;
 }
 return new object[] { value };
}

然后将该 Converter 应用到刚才 TextBlock.Text 的绑定中。需要首先引入命名空间，然后将 Converter 添加到资源当中，并设置它的 Key。最后添加到绑定中。

<Window [...]
 xmlns:converter="clr-namespace:IndexWithItemsControl.Converters"
 [...]>
 <Window.Resources>
 <converter:IndexOfItemsControlConverter x:Key="IndexOfItemsControlConverter"/>
 </Window.Resources>
 <Grid>
 <Grid.ColumnDefinitions[...]>
 <ItemsControl>
 <ItemsControl.ItemsSource[...]>
 <ItemsControl.ItemsPanel[...]>
 <ItemsControl.ItemTemplate>
 <DataTemplate>
 <CheckBox[...]>
 <TextBlock>
 <TextBlock.Text>
 <MultiBinding Converter="{StaticResource IndexOfItemsControlConverter}">
 <Binding[...]>
 <Binding[...]>
 </MultiBinding>
 </TextBlock.Text>
 </TextBlock>
 </CheckBox>
 </DataTemplate>
 </ItemsControl.ItemTemplate>
 </ItemsControl>
 </Grid>
</Window>

现在调试运行一下，看绑定的控件是否都传入了。

如果和上图一样，都是这 ItemsControl 和 CheckBox 类型，那么说明绑定成功了。如果调试步骤没有进入 Convert，或者 values 的内容有区别，需要检查一下绑定是否是按照上面的来的。

你可能注意到了有几个绑定失败的提示，这是因为在 Convert 中返回的 values 在退出函数之后被销毁了，所以 TextBlock.Text 拿到了一个空值。

如果需要拿到非空值，需要使用 values.Clone()。

现在需要的内容都有了，开始获取 Index 吧！

在 Convert 函数中，先把 ItemsControl 和 CheckBox 选出来。

public object Convert(object[] values, Type targetType, object parameter, CultureInfo culture)
{
 ItemsControl? itemsControl = null;
 CheckBox? checkBox = null;
 foreach (var val in values)
 {
 if (val is ItemsControl i)
 {
 itemsControl = i;
 continue;
 }
 if (val is CheckBox c)
 {
 checkBox = c;
 continue;
 }
 }
 return "";
}

然后，调用方法来获取 Index。

public object Convert(object[] values, Type targetType, object parameter, CultureInfo culture)
{
 // ...
 if (itemsControl != null && checkBox != null)
 {
 var index = itemsControl.ItemContainerGenerator.IndexFromContainer(checkBox);
 return index;
 }
 return "";
}

生成一下项目，回到设计器，会发现 Text 还是没有内容。

在 var index = ... 处打上断点，然后调试执行。看向 Index，会发现其值为 -1。

这显然不符合我们的需求，IndexFromContainer 并没有找到我们需要的 Index，同时取消断点，会发现绑定又失败了，绑定的值又变为了 null。

看向官方文档 RelativeSourceMode Enum，有一项叫做 TemplatedParent。翻译看看描述。

大概意思是能够获取到绑定的模板控件，那么将绑定的内容修改一下：

<MultiBinding[...]>
 <Binding[...]>
 <Binding RelativeSource="{RelativeSource Mode=TemplatedParent}"></Binding>
</MultiBinding>

同时在 Convert 方法中打一下断点，看看其内容。

发现它的类型是 ContentPresenter。修改 Convert 函数的内容。

public object Convert(object[] values, Type targetType, object parameter, CultureInfo culture)
{
 ItemsControl? itemsControl = null;
 // modify
 ContentPresenter? content = null;
 foreach (var val in values)
 {
 if (val is ItemsControl i)
 {
 itemsControl = i;
 continue;
 }
 // modify
 if (val is ContentPresenter c)
 {
 content = c;
 continue;
 }
 }
 // modify
 if (itemsControl != null && content != null)
 {
 // modify
 var index = itemsControl.ItemContainerGenerator.IndexFromContainer(content);
 return $"{index}";
 }
 return "";
}

再次生成项目，回到设计器，应该可以看到 Text 的内容变成 Index 了。

当然可以返回时 +1，即 return $"{index + 1}"; ，这样显示的起始 Index 就是 1 了。

附

仓库链接：IndexWithItemsControl

文档列表：

WPF 使用记录目录

Fri, 23 Feb 2024 20:42:48 +0800

说明

最近正在做 WPF 的项目，制作的时候有些功能的实现比较难，但是实际上编写出来之后也没有特别多的代码。

不过由于网络上能找到的资料很少，大部分都是网上找到的方法没有效果之后，通过一些其他较为复杂的方法实现了。

所有用到的参考文档和资料除了在每篇博客文章中外，还会在此目录页做汇总。相关的项目有时间会上传。

所有示例项目用的版本为 .net 6.0。

用到的依赖

为了方便快速开发，所有的项目基本都会用到下面的依赖：

CommunityToolkit.Mvvm
MaterialDesignThemes

MaterialDesignThemes 需要根据 Getting Start 来进行配置。

同时其 Demo 程序是重要的参考，如果和我一样使用 Release 版，可以直接去 Github 的 Release 中下载 DemoApp，如果想使用最新版的功能，可以克隆整个项目，并直接运行 Demo 项目。

使用条件格式设置介于最大最小值之间的单元格格式

Fri, 02 Feb 2024 20:20:45 +0800

公式参考公式中如何固定获取相对单元格的值

问题

之前没怎么使用过 Excel，在遇到复杂的需求的时候就需要研究很久，所以这次记录下来。

情况是这样的，给一个最小值和最大值，介于两者之间的值的单元格，统一设置一个填充颜色。

使用条件格式

网上查找很容易就找到了条件格式。

假设现在有以下表格，要做的就是将下面的满足条件的值设置一个颜色。（图片使用的是 WPS，但 LibreOffice 和 Microsoft Office 的操作方式基本一致）

首先选中下面 1-29 所有的单元格，然后点击条件格式 -> 新建规则。应该会出现下图所示的弹窗。

然后选择第二项只为包含以下内容的单元格设置格式，第一个输入框可以输入最小值，也可以如下图一样选择一个单元格的值，第二个输入框同理，输入的是最大值。输入框下的格式就是配置满足条件后，单元格会被设置的格式。此处设置了单元格的颜色为淡青色。

点击确定后，应该可以看到满足条件的单元格变色了，并且如果改变选择的最大最小值，可以看到单元格颜色的变化。

利用同样的方式，可以设置更多的值的范围，最终可能得到的效果如下图。

另一种需求？

现在出现了另一种情况，并不是每个单元格都有一个值，如下图，但是我们需要根据有数值的那一行和有数值的那一列来设置中间没有数值的单元格格式。

这时候就要用到四个公式（参考公式中如何固定获取相对单元格的值）：

ROW()：获取当前行号
COLUMN()：获取当前列号
ADDRESS()：根据行和列获取当前地址
INDIRECT()：从给定的地址取值

有了这四个公式，就可以拿到想要的单元格的值了。

例如 INDIRECT(ADDRESS(ROW()-1,COLUMN()-1))，就是查找自身上一行和上一列的单元格值。

不过由于是根据自身单元格的行和列来查找的，所以需要一行一行或一列一列来设置。

选择一行空行，然后新建规则，选择使用公式确定要设置的单元格。将下面的公式复制到输入框中：

=AND(INDIRECT(ADDRESS(ROW()-1,COLUMN()))>=,INDIRECT(ADDRESS(ROW()-1,COLUMN()))<=)

通过鼠标点击，将光标调整到大于等于号后面，然后选择最小值的单元格，同理后面的小于等于号，选择最大值的单元格，设置好格式后点击确定即可。

整个过程可见下面的动图。

看起来效果还可以，但别忘了我们还有一列有数值的单元格。所以还需要一个 INDIRECT 获取对应的值，并将两者加起来。获取第一列的值的公式如下：

=INDIRECT(ADDRESS(ROW(),1));

如果不知道是第几列，1 的位置可以替换成 COLUMN() - INDIRECT(ADDRESS(ROW()-1,COLUMN()))，替换完的公式如下：

=INDIRECT(ADDRESS(ROW(),COLUMN() - INDIRECT(ADDRESS(ROW()-1,COLUMN()))));

将获取第一列的值和上一行的值结合起来，可以得到下面的公式：

=AND(INDIRECT(ADDRESS(ROW()-1,COLUMN()))+INDIRECT(ADDRESS(ROW(),COLUMN() - INDIRECT(ADDRESS(ROW()-1,COLUMN()))))>=,INDIRECT(ADDRESS(ROW()-1,COLUMN()))+INDIRECT(ADDRESS(ROW(),COLUMN() - INDIRECT(ADDRESS(ROW()-1,COLUMN()))))<=)

设置时，由于公式太长不太好将光标移动到想要的位置，可以用上面的 INDIRECT(ADDRESS(ROW(),1)) 替换 INDIRECT(ADDRESS(ROW(),COLUMN() - INDIRECT(ADDRESS(ROW()-1,COLUMN())))。

看起来很长，实际上就是将行值和列值加起来了。按照上面的方法设置条件格式，应该可以获得下面的效果：

同时应该注意到，每个单元格可以设置多个条件格式，所以在对每一行进行重复设置后，应该可以得到下面的效果。

后记

Excel 在使用的时候，无不感觉商业软件在易用性上的成功。但一旦需要一些奇怪或是复杂的需求，光靠 Excel 自身就非常困难。上面可以看到，其实就五个简单的公式，但是完成复杂需求时就会组合嵌套导致公式巨长无比。而且条件格式的公式输入框的光标移动键，被强行改成了单元格选择，这就导致修改更加不便，也不知道为什么这么设计，明明旁边已经有了一个切换单元格选择的按钮。

当然这次后面的情况，实际上不太会出现，有的话应该就一行或一列，不太会出现列行同时的情况。

Excel 示例表格可以点击此处获取。

记一次使用 Github action 同步 Gitee 仓库到 Github

Mon, 01 Jan 2024 11:07:34 +0800

原因

开始尝试用 vuepress 编写文档，由于默认主题配置不是很方便，于是又尝试了 vuepress-theme-hope，这个主题使用起来更舒服，配置更加方便快捷，顺带还提供了自动构建的 Github action。

于是就想着把私有仓库中构建好的页面，提交到公开仓库去，这样就可以使用 Github page 来部署了。

思路很简单，首先是将 Gitee 的仓库同步到 Github 中去，然后就可以尝试触发 vuepress-theme-hope 的 Github action 来构建页面，构建好的页面存在另一个分支当中，把这个分支的提交同步给公开仓库就行了。

开始尝试同步

最简单的方式是先克隆 Gitee 的仓库，然后再提交到 Github。克隆 Gitee 仓库有两种方式，一种是通过 ssh，可以获取到提交记录；另一种是使用 Gitee 的 Open API，但这种方式不会有 Gitee 上的提交记录。

首先要有一个 Github Token。在 Github 的设置里找到 Developer Settings，选择 Personal access tokens -> Tokens (classic)，选择 Generate new token (classic)。Expiration 即有效期，根据自己的需求选择，我选择了无限期，然后下面的权限将 repo 和 workflows 全点上。

Token 一定不要泄漏！

ssh 克隆仓库

首先需要生成一个 ssh 密钥。如何生成可以查看 Gitee 的文档生成、添加 SSH 公钥。使用的指令如下：

> ssh-keygen -t ed25519 -C "Gitee SSH Key"

生成的密钥可以通过打印到控制台的信息查看。找到保存密钥的位置（windows 在 C:\Users\{user}\.ssh 处，linux 位于 ~/.ssh 文件夹下）。带有 .pub 后缀的为公钥，此处添加到了 Gitee 仓库的公钥中。设置为仓库的公钥可以保证这个公钥只用于克隆和同步仓库，可以增加安全性。

在 Github 创建一个和 Gitee 仓库同名的仓库，并将私钥配置给对应的 Github 仓库。找到仓库设置，找到 Secrets and Variables，点击 New repository secret，名字随意，然后将私钥的内容复制进去。

同理，之前生成的 Token 也要作为 secrets 配置进去。

这一步完成之后，我们就可以尝试使用 ssh 来克隆仓库了。

测试 ssh

按照 Gitee 的文档，接下来需要测试一下 ssh 连接是否能够联通。由于 Github action 的环境使用 linux 会更加简便，所以此处测试连接使用了 linux 环境。

在 ~/.ssh/id_ed25519 中，将私钥复制进去。然后输入下面的命令测试连接：

> ssh -T git@gitee.com

回车执行之后，会有如下的提示内容：

@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@ WARNING: UNPROTECTED PRIVATE KEY FILE! @
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
Permissions 0777 for '/home/xueshihao/.ssh/id_ed25519' are too open.
It is required that your private key files are NOT accessible by others.
This private key will be ignored.
Load key "/home/xueshihao/.ssh/id_ed25519": bad permissions
git@gitee.com: Permission denied (publickey).

linux 下，将私钥文件的文件属性设置为只读就行。使用下面的指令设置权限：

> chmod 700 ~/.ssh/id_ed25519

再次尝试测试连接，会提示下面的内容：

The authenticity of host 'gitee.com (180.76.198.77)' can't be established.
ECDSA key fingerprint is SHA256:FQGC9Kn/eye1W8icdBgrQp+KkGYoFgbVr17bmjey0Wc.
Are you sure you want to continue connecting (yes/no/[fingerprint])?

为了模拟 Github action 的方式，此处直接回车，然后会发现无法连接，提示如下：

Host key verification failed.

具体解决方案可以查看这篇博客：SSH 连接时出现 Host key verification failed 的原因及解决方法。需要修改的配置的条目，可以在 ssh 的文档中找到：ssh_config - StrictHostKeyChecking

打开或创建 ~/.ssh/config 文件，将下面的内容添加到文件当中：

Host gitee.com
StrictHostKeyChecking=no

配置完成后，再次输入 ssh -T git@gitee.com 并回车，就没有问题了。

Github action 使用 ssh

完成了 ssh 的连接测试，接下来就可以先将上面的内容转存到 Github action 中了。在仓库的根目录创建 .github 文件夹，并在 .github 下创建 workflows 文件夹。创建一个文件末尾格式为 .yml 的文件，并在文件中输入下面的内容：

name: Mirror sync
on:
 schedule:
 - cron: "0 0 * * *"
 workflow_dispatch:
env:
 REPO_NAME: repo-name
jobs:

name 是这个 action 的名字；on 表示在什么情况下触发这个 action，schedule 下设置了触发的时间，为每天的 0 点（北京时间 8 点），workflow_dispatch 则是可以手动运行 action。

env 中的键值对，代表运行时，控制台的环境变量，可以自由设置。但这个变量是公开可见的，所以不建议将 token 之类的东西写在这里。

关于 Github action 的其他内容可以查看官方文档或者是使用到的 Github action 的示例。

由于 Github action 的用户目录没有 .ssh 文件夹，所以需要自己创建。然后将 ssh 的配置和私钥写入到对应的文件当中，注意私钥文件的文件权限，需要配置为只读。

jobs:
 merge:
 runs-on: ubuntu-latest
 steps:
 - uses: actions/checkout@v4
 - name: Down load gitee source
 run: |
 mkdir ~/.ssh
 echo "Host gitee.com
 StrictHostKeyChecking=no" > ~/.ssh/config
 echo "${{ secrets.GITEE_SSH_PRIVATE_KEY }}" > ~/.ssh/id_ed25519
 chmod 700 ~/.ssh/id_ed25519
 eval $(ssh-agent)
 ssh -T git@gitee.com
 git clone git@gitee.com:your_name/${{ env.REPO_NAME }}.git

通过 eval 启用 ssh 认证，就可以克隆 Gitee 的私有仓库了。

提交到 Github

在上面的基础上，添加下面的指令：

jobs:
 merge:
 runs-on: ubuntu-latest
 steps:
 - uses: actions/checkout@v4
 - name: Down load gitee source
 run: | # .....
 cd ${{ env.REPO_NAME }}
 git remote add github https://${{ secrets.REPO_TOKEN }}@github.com/studylessshape/game-story-private
 git push github master -f

这三个指令的作用分别是：

进入到克隆的目录
为当前的本地仓库添加远程 remote
提交到 Github

将配置好的 action 文件提交到 Gitee 和 Github 的仓库上。然后修改一些其他文件的内容并提交到 Gitee 仓库上。

在 Github 的仓库页面，找到 Action，然后找到 Mirror sync。

点击旁边的 Run workflow，再点击绿色的 Run workflow。刷新一下就可以看见一个正在执行的工作流了。如果之前配置 Gitee 的 ssh 的公钥和私钥、以及 Github 的 Token 没有问题，那么运行结束后，所有的条目将都是正常完成的。

使用 Gitee Open API（不推荐）

完整的 Github aciton 直接放在下面了：

name: Mirror sync
on:
 schedule:
 - cron: "0 0 * * *"
 workflow_dispatch:
env:
 GITHUB_REPO_NAME: <your-github-repo>
 GITEE_DIR_NAME: <your giteee repo>-<branch>
jobs:
 merge:
 runs-on: ubuntu-latest
 steps:
 - uses: actions/checkout@v4
 - name: Down load gitee source
 run: |
 wget https://gitee.com/api/v5/repos/<your_name>/<your-repo>/zipball?access_token=${{ secrets.GITEE_ACCESS_TOKEN }} -O <branch>.zip
 unzip <branch>.zip
 cp $GITEE_DIR_NAME/* . -r
 rm $GITEE_DIR_NAME <branch>.zip -rf
 - uses: EndBug/add-and-commit@v9 # You can change this to use a specific version.
 with:
 default_author: github_actor
 fetch: false
 committer_name: GitHub Actions
 committer_email: 41898282+github-actions[bot]@users.noreply.github.com
 pathspec_error_handling: ignore

要使用 Gitee Open API，需要先生成一个私人令牌。

生成私人令牌

在 Gitee 的个人设置里，找到私人令牌，点击生成新令牌，建议只勾选 projects 权限。

点击生成，将生成好的内容复制。打开对应的 Github 仓库，在 Secrets and Variables -> Actions 中，新建一个仓库机密，命名为 GITEE_ACCESS_TOKEN。这样，Github action 就能够使用这个私人令牌了。

Action 中的命令解释

上面 Action 的命令逻辑很简单，首先是通过 Gitee Open API 将对应仓库的代码的 zip 下载下来，然后直接解压。关于 Gitee Open API 可以查看 Gitee 的 Swagger 文档，只不过文档中并没有将所有的 API 列出来，比较可惜。

因为 actions/checkout@v4 以及将当前 Github 仓库的代码拉取下来，并将工作目录切换到了克隆的目录，所以直接将解压出来的所有的文件内容替换到当前文件夹下。同时记得需要删除解压出来的文件以及下载下来的安装包。

最后使用 EndBug/add-and-commit@v9 来执行提交操作。

后记

其实之前准备尝试使用 hub-mirror-action 来同步的，但是这个 action 只能支持一段的私钥和 Token 的配置，所以只能够同步公开仓库。

两种不同的方式的 action 都发布到这个仓库了：sync-gitee-to-github

如何入门 Rust 的宏？

Sun, 17 Dec 2023 22:16:02 +0800

避免长篇大论，可以直接翻到最底下的整理一栏。

Rust 的宏是什么？

Rust 的宏可以看作编译时期，将代码按照编写好的宏规则去生成的指令。换句话说就是用一定的规则将原来的代码替换掉。

常见的宏有两种，一个是 macro_rules! 声明的声明式宏，另一种是和 Rust 函数一样的写法的过程宏。

如何入门/学习

之前我也是看见宏复杂的符号和奇怪的语法，而没有想法去学习。

学习宏我觉得最重要的还是通过实例去学习，需要一定的积累才能够理解宏，首先要理解宏做了什么，然后才是实现它。

入门学习必备的 crate 和工具

有几个很方便的 crate，在宏小册中也提到了，学习过程宏时，使用这几个 crate 会很方便。

syn：面向过程宏，解析语法树
quote

必备的工具是 cargo-expand，使用下面的指令安装和使用：

cargo install cargo-expand # install
cargo expand # run

cargo-expand 可以展开宏代码，看到代码通过宏替换后的样子，非常方便，除了可以观察自己的宏有哪些问题，还可以观察其他 crate 中，复杂的宏在使用时发生了什么。

入门学习的教程和网站

宏到底是个什么，可以阅读一下 Rust 参考手册（中文版非官方翻译），了解声明宏和过程宏。

入门学习宏可以使用 proc-macro-workshop 进行学习。这个仓库中包含了几个比较常用的声明宏和过程宏的实现模板。并且同时可以阅读学习使用 macro_rules! 来创建宏（通过例子学 Rust 中文版）。

syn、quote 和 proc-macro-workshop 都是大佬 dtolnay 实现的，真的太强了！

另外，宏小册，即 The Little Book of Rust Macros，可以当作工具书进行参阅。

闲话

一个朋友之前尝试写了个类似于 lisp 的脚本语言的解析库，名叫 dj。我就尝试为其实现一个运行器，方便测试和运行。

而最近突然萌生了写宏的想法，刚好又完成了 dj-runner 的编程。在实现的过程中发现 dj 中的 Value::Builtin，和 actix-web 中的路由以及 bevy 中的 System 有着相似的形式，就想着能不能尝试将内建函数的形式简化。

后来实际的实现与路由和 System 差别挺大的，实现的方式也比较粗暴，但总的来说效果还不错，能够感觉到一些学习宏并实现一个的成就感。

整理

crate
- syn：面向过程宏，解析语法树
- quote
教程

有关 Axum 中 WebSocket 的使用

Sun, 22 Oct 2023 13:34:59 +0800

开始

创建 `axum` 项目

创建一个项目，并将 axum 添加到依赖中：

cargo new axum-ws-test
cd axum-ws-test
cargo add tokio -F full
cargo add serde_json
cargo add axum -F ws
cargo add rand

然后用自己喜欢的编辑器/IDE 打开整个项目，找到 Cargo.toml，可以看到 Cargo.toml 如下：

[dependencies]
axum = { version = "0.6.20", features = ["ws"] }
rand = "0.8.5"
serde_json = "1.0.107"
tokio = { version = "1.33.0", features = ["full"] }

以上依赖版本为本文编写时的最新稳定版，需要注意和自己的版本区别，axum 的功能基本都有解释，可以查看 axum 文档

`axum` 的程序基本结构

从官方文档可以看到，一个 axum 程序，包含了程序入口、路由、路由服务和 axum 服务端（即 axum::Server），我们先将其基本结构写入到 main.rs 的文件中（代码来自官方文档）：

use axum::{routing::get, Router};

// 主函数入口
#[tokio::main]
async fn main() {
 // 路由
 let app = Router::new().route("/", get(|| async { "Hello, World!" }));

 // axum 的 Server
 axum::Server::bind(&"0.0.0.0:8081".parse().unwrap())
 .serve(app.into_make_service())
 .await
 .unwrap();
}

运行程序后，打开 localhost:8081，应该可以看见网页上有 Hello, World!。

创建前端项目

前端使用 Vue，建议选择另一个文件夹来创建前端项目。输入下面的指令来创建前端项目，项目名称命名为 axum-test-front：

npm create vue@latest
cd axum-test-front
npm install
npm run dev

直接使用 Http 请求

我们模拟的情况试试，前端每次点击按钮都会获取后端的一个随机数。一开始我们先不使用 WebSocket，来测试一下效果。

后端代码

添加一个函数，用于前端获取随机数：

use axum::{response::Json, routing::get, Router};
use rand::Rng;
use serde_json::{json, Value};

#[tokio::main]
async fn main() {
 let app = Router::new()
 .route("/", get(|| async { "Hello, World!" }))
 // add here
 .route("/random", get(get_rand));

 // Server
}
// handler
async fn get_rand() -> Json<Value> {
 let mut rng = rand::thread_rng();
 Json(json! ({"num": rng.gen_range(1..=100)}))
}

可以在浏览器中输入 localhost:8081/random来测试，每个刷新应该都可以得到一个新的 num 值。

前端代码

前端在 App.vue 中添加一个按钮和一个用于显示获取到的随机数的节点，代码如下：

<script>
 export default {
 data() {
 return {
 num: null,
 };
 },
 methods: {
 get_random() {
 // 从后端的对应地址获取随机数
 fetch("http://localhost:8081/random", {
 mode: "cors",
 headers: {
 accpet: "application/json",
 },
 })
 .then((response) => response.json())
 .then((data) => {
 this.num = data.num;
 });
 },
 },
 };
</script>

<template>
 <main>
 <button @click="get_random()">click to get num</button>
 <div>num is {{ num }}</div>
 </main>
</template>

执行的时候会发现无法从后端拿到数据，这是因为后端没有配置跨域请求。

为后端配置跨域

首先需要添加一个依赖，输入下面的指令添加：

cargo add tower-http -F cors

然后在创建路由之前，先新建一个跨域的许可：

use axum::{http::HeaderValue, response::Json, routing::get, Router};
use rand::Rng;
use serde_json::{json, Value};
use tower_http::cors::{Any, CorsLayer};

#[tokio::main]
async fn main() {
 // 跨域配置
 let cors = CorsLayer::new()
 .allow_methods(Any)
 .allow_headers(Any)
 .allow_origin("http://localhost:5173".parse::<HeaderValue>().unwrap());

 let app = Router::new()
 .route("/", get(|| async { "Hello, World!" }))
 // 为路由方法处理添加跨域许可
 .route("/random", get(get_rand).layer(cors));

 // Server
}

这时再运行后端和前端，打开前端的网页，点击按钮应该可以每次获取到不同的数字。打开开发者控制台，并选择网络（没有的话点加号或者 》 可以找到），再多次点击按钮，可以看到每次点击按钮都发送了一次 Http 请求。

如果前端开发者控制台报 Uncaught (in promise) ReferenceError: num is not defined 这种错误，应该是在给 Vue 中 data 里的字段赋值的时候没有加 this 关键字，把 num 改为 this.num 即可

改为 WebSocket 传输随机数

后端代码修改

添加一个新的函数，函数名为 handle_random，再添加一个函数名为 handle_random_socket：

async fn handle_random(ws_upgrade: WebSocketUpgrade) -> Response {
 ws_upgrade.on_upgrade(handle_random_socket)
}

async fn handle_random_socket(mut socket: WebSocket) {
 while let Some(msg) = socket.recv().await {
 let msg = if let Ok(msg) = msg {
 msg
 } else {
 println!("Web Socket Closed");
 return;
 };

 }
}

在 handle_random 中，调用 ws_upgrade 的 on_upgrade 函数可以建立 Web Socket 连接。handle_random_socket 就是用于处理连接时的函数，此处先使用循环来接收来自连接另一端的消息，如果接收发生错误或者无法接收到，则视为连接关闭。WebSocket::recv() 函数在连接关闭后，才会返回 None。

设想建立连接后，前端发送一个 get 字符串，后端收到这个字符串，如果收到的确实是 get，则返回给前端一个随机数。那么要做的事情就很简单了，首先要匹配发送过来的消息是否是字符串且内容是否为 get。

async fn handle_random_socket(mut socket: WebSocket) {
 while let Some(msg) = socket.recv().await {
 let msg = if let Ok(msg) = msg {...};
 // 匹配字符串
 if let Message::Text(text) = msg {
 if text.eq("get") {
 todo!()
 }
 }
 }
}

在匹配成功后，将生成一个随机数，并返回给前端。这里会用到 WebSocket 的 Send 函数来返回响应，获取随机数可以用到之前写的函数。前端对数据的宽容性较大，所以可以考虑直接返回 JSON 格式的文本：

async fn handle_random_socket(mut socket: WebSocket) {
 while let Some(msg) = socket.recv().await {
 let msg = if let Ok(msg) = msg {...};

 if let Message::Text(text) = msg {
 if text.eq("get") {
 if socket
 // 返回随机数
 .send(Message::Text(get_rand().await.to_string()))
 .await
 .is_err()
 {
 // 如果出错了就关闭连接
 println!("Web Socket Closed");
 return;
 }
 }
 }
 }
 println!("Web Socket Closed");
}

编写完成，最后将 handle_random 添加到路由中。

#[tokio::main]
async fn main() {
 // 跨域配置
 // ...
 // 路由
 let app = Router::new()
 .route("/", get(|| async { "Hello, World!" }))
 .route("/random", get(get_rand).layer(cors));
 .route("/ws/random", get(handle_random));

 // axum 的 Server
 // ...
}

前端代码修改

在组件挂载时，会尝试创建一个 WebSocket 的连接，并且绑定一个函数，用于在收到消息后，设置 num 的值：

<script>
export default {
 data() {
 return {
 num: null,
 ws: null,
 };
 },
 methods: {
 build_connect() {
 // 防止子域的 this 与 vue 的 this 冲突
 var that = this;
 that.ws = new WebSocket("ws://localhost:8081/ws/random");
 // 收到消息后，设置 num 的值
 that.ws.addEventListener("message", function (event) {
 that.num = JSON.parse(event.data).num;
 });
 },
 },
 mounted() {
 this.build_connect();
 window.onclose = () => {
 this.ws.close();
 };
 },
};

之后的每次点击都会变为通过连接来向后端发送消息。按照逻辑修改后的代码如下：

get_random() {
 // 通过连接向后端发送信息
 this.ws.send("get");
},

运行

首先启动后端：

cargo run

然后启动前端：

npm run dev

打开前端页面，点击按钮就可以看到每次都能够从后端获取到不同的随机数的效果了。