RDM 从源码编译

2022-02-02 10:09:43

RDM 从源码编译

Redis Desktop Manager -> RDM 一个超赞的redis开源客户端管理工具。感谢项目的作者@uglide，一个软件从源码到编译也不是一件容易的事情。所以有条件且嫌麻烦的朋友可以直接去官网购买https://resp.app/pricing。

环境准备

根据官文Build from source准备所需依赖

接下来对上面的提到的依赖进行逐一破解。

本着先易后难的原则VS2019、git、python39这三个软件都是常用软件不做过多介绍，需要说明的安装VS2019的时候必须现在C++载荷因为RDM使用C++开发的。

分别去https://cmake.org/download/、http://www.equation.com/servlet/equation.cmd?fa=make、https://www.nuget.org/downloads这三个地方把cmake、make和nuget下载到本地并添加到系统环境变量中,追加到%path%上，在找make for windows 命令的时候发现这篇关于windows上make和cmake命令的集成说的比较好。

接下来就是按照官网在windows上编译小节step by step。在这期间自己犯了一个非常严重且愚蠢的错误，在上面起码耗费了4个小时甚至还跑到RDM的GitHub上提交issue。究竟怎么回事儿请继续往下看！！！

编译lz4

根据官网说明进行操作，需要注意的时候Windows上执行make命令会报错：

/WorkSpace/rdm/3rdparty/lz4/build/cmake $ make
make: *** No targets specified and no makefile found.  Stop.

解决办法是：直接用VS2019进行编译。

编译过程极度舒适进入lz4/build/cmake目录双击LZ4.sln解决方案文件默认用VS2019打开。按照如下截图操作

等待编译完成即可。

使用Qt Creator 构建rdm项目

由于Qt从5.15开始不提供离线安装包，在GFW内无疑是阻碍了丝滑度。所以我这边一股脑儿的想要找到5.15的离线按照包。找来找去对本次编译唯一有用的是发现了这个网站如果要学习Qt她绝对是国内不二的选择，根据上面的介绍如果要得到5.15的离线安装包就需要自行编译，这个的编译成本非常之高。究竟有多高，看看在你这里就知道了[在 Windows 10 编译 Qt 5.15 源代码的详细过程步骤详解]。哇哇哇哇~~~~ 这么多依赖，关键是对于一个不进行Qt开发的人来说这么一次编译成本未免也太大了。果断选择其他方式。也许是快过年了头脑以己经开始了休假模式，一不留神把看成了

心想不是说不开放离线按照包么，怎么被我找到了呢。这就是我在RDM的GitHub上issue的开端。具体问题欢迎强势围观。

心情开始烦闷了。。。。。正好午饭时间到，去食堂解决一下口腹之欲再说。

午休间隙突然发现，明明官文上说的是Qt5.15我这里怎么是Qt5.14.2，这不是自己搞错了么还跑去提issue丢人丢到家了。怎么搞呢，5.15没有离线安装，哎~~~ 为了把RDM编译成功我也是拼了。哈哈哈~ ~ ~ 拿出我珍藏多年的梯(dai)子(li)去Qt官网的5.15下载站点将在线安装包下载下来进行安装。

安装的时候按照如下截图选择主键即可：

等待安装完成即可。

修改项目文件以符合实际情况

被注释掉代码是原有的，需要修改成实际python的地址。

更新语言

如果不做此操作编译后的程序默认是英文的

Run build. (Just hit Ctrl-B)

解决其他依赖

观察Qt Creator的信息输出窗口没有出现之前的

E:\WorkSpace\rdm\src\app\models\connectionsmanager.cpp:133: error: C2027: 使用了未定义类型“QUuid”
E:\WorkSpace\rdm\3rdparty\qredisclient\src\qredisclient\connectionconfig.h:120: error: C2027: 使用了未定义类型“QSet<T>”
with
[
    T=QString
]
E:\WorkSpace\rdm\src\app\models\connectionsmanager.cpp:133: error: C3861: “createUuid”: 找不到标识符

E:\WorkSpace\rdm\src\app\models\connectionsmanager.cpp:133: error: C2027: 使用了未定义类型“QUuid”

类似报错了，心想总算进入了实质性的编译阶段了。但是。。。。。

根据错误提示定位到第三方模块snappy经过一番查找发现只有snappy-stubs-public.h.in文件，我不懂C/C++抱着试一试的想法把这个模块编译一下。查看其README.md与编译相关信息可以得知该模块是如何编译的：

因为是在Windows平台所以这里仅仅执行到cmake就需要切换到VS2019上进行最后的的make操作。在这过程中在build目录下发现了所需要的snappy-stubs-public.h文件。省去make步骤直接把它拷贝到snappy.h同级目录。再在Qt Creator中执行Build操作。但是。。。还是但是。。。。

明明之前都把python的绝对路径写死在代码里面了，这会儿怎么又冒出这个python相关的问题，看错误信息

## Fatal Python error on Windows 10 ModuleNotFoundError: No module named 'encodings'

用ipython测试一下：

$ ipython
Python 3.9.7 (tags/v3.9.7:1016ef3, Aug 30 2021, 20:19:38) [MSC v.1929 64 bit (AMD64)]
Type 'copyright', 'credits' or 'license' for more information
IPython 7.30.1 -- An enhanced Interactive Python. Type '?' for help.

In [1]: import encodings

In [2]:

没有问题呀！怎么回事儿。好！是时候请出Google大神了

找到了一篇文章Windows 10上的致命Python错误ModuleNotFoundError：没有名为’encodings’的模块根据文章的说明新建两个环境变量PYTHONHOME=E:\program\python39和PYTOHNPATH=E:\program\python39\Scripts然后重启Qt Creator让配置的新环境变量生效。然后继续编译，好事多磨，这次编译又报出

好在问题越来越具体和清洗了，根据报错信息定位到3rdparty模块的对应目录，找到他的README.md文件查看该库是如何编译以及使用的。依据其README.md，项目已经在zstd/build/cmake/中提供了cmake的项目生成器，可以生成Makefile或者编译脚本。那么直接转到该目录下执行cmake命令即可生成编译脚本，然后使用VS2019编译出对应的生成物，然后将生成物拷贝的依赖提示的位置接下来的错误均是按照此操作进行

此处还有一个报错，不像前面的报错可以清晰的知道属于哪个第三方模块所在的目录

这么办呢，好在我这里收藏的神器比较多，铛铛铛铛铛~~~~everything

咿~~~~ 这货是个 java ，翻看其README.md果然不同寻常，难道我还要去搞个mvn来编译这货。。。。结果让我失望了，他提供了cmake编译方式：

通过cmake也能编译。好吧，执行上面的命令，进行编译，编译完成将out/Release目录拷贝的插件的根目录下也就是README.md同级目录。

编译成功

千呼万唤始出来。。。

软打包

到rdm\bin\windows\release去执行一下rdm.exe看看效果。┭┮﹏┭┮ 呜呜~~~~ 不带这么玩儿的呀！！

在Qt Creator里面RUN一下呢，这又能跑起来。好奇怪。

查了一下，这是因为Qt Creator编译好的exe程序是没有关联依赖库的，需要使用windeployqt这个工具将依赖库部署过来。也就是说编译成功只是倒数第二步或者第三步。

`windeployqt`对rdm.exe进行部署

将编译好的rdm.exe拷贝到rdm/build/windows/installer/resources目录中，并在此目录中编写assemble.bat文件。

文件内容如下:

@echo off
:: 执行依赖库引入
:: 注意: 命令中的windeployqt是一个exe程序, 
:: 该程序的目录需要按实际Qt的安装位置修改, 
:: \src\qml目录也是按源码解压时所在位置的绝对路径修改
set windeployqt=E:\Qt\5.15.2\msvc2019_64\bin\windeployqt.exe
set src_path=E:\WorkSpace\rdm\src
%windeployqt% --no-angle --no-opengl-sw --no-compiler-runtime --no-translations --release --force --qmldir %src_path%\qml rdm.exe
:: 删除一些不必要的文件
rmdir /S /Q .\qmltooling
rmdir /S /Q .\QtGraphicalEffects
del /Q  .\imageformats\qtiff.dll
del /Q  .\imageformats\qwebp.dll
echo Assemble complate! Press every key exit.
pause > nul

现在双击rdm/build/windows/installer/resources/rdm.exe能正常运行了

处理软件分发

到现在位置软件已经RDM算是编译完成并且可以在本机中分发了，为什么说是本机呢？因为程序运行运行所需的python.dll和python.zip依赖包旨在本机中存在，如果分发找其他其上一定会报错缺少python.dll而无法运行。因此需要将这两个依赖从[python-embed]包中复制到rdm/build/windows/installer/resources/中（python-embed是pytohn的一种机制提供了C/C++调用python代码进行交互）。这样分发到其他机器上就可以正常使用了。但是点击右上角的【日志】按钮出现如下信息，感觉似乎哪个依赖包不正确。

经查原因如下：

这是对redis的value值进行解析的扩展没有找到, 比如显示为二进制, msgpack等, 默认已经自带文本, json, 十六进制。添加对应的处理依赖包

只需要将rdm/src/py/formatters/所有.py文件拷贝到rdm/build/windows/installer/resources/formatters目录下就想了。即在git-bash执行：
cp -rv rdm/src/py/formatters/*.py rdm/build/windows/installer/resources/formatters/
为了节省空间可以在formatters目录中执行如下命令

rdm/build/windows/installer/resources/formatters/ $ python -m compileall -b .
rdm/build/windows/installer/resources/formatters/ $ rm -rf *.py

至此，一个绿色版的rdm就生成了。为了方便可以执行如下命令进行打包：

rdm/build/windows/installer/resources $ 7z a -tzip -mx9 resp-noinstaller-2022.zip * -r
7-Zip [32] 15.12 : Copyright (c) 1999-2015 Igor Pavlov : 2015-11-19

Scanning the drive:
42 folders, 736 files, 60113121 bytes (58 MiB)

Creating archive: rdm-2021.zip

Items to compress: 778


Files read from disk: 736
Archive size: 24479939 bytes (24 MiB)
Everything is Ok

制作安装包

根据我自己的使用习惯做出noinstaller就可以了。但是rdm项目的作者很用心居然提供了NSI脚本，那我就来试一下将rdm制作成安装包。

首先需要下载nsis这个软件，它是制作软件安装包的工具，目前版本是v3.08同样我也是下载的noInstaller版本。运行NSIS.exe

我们有NSI脚本因此选择这个

对installer.nsi脚本进行修改

rdm/build/windows/installer $ sed -i '/^Name "RDM"/a\# version\n!define VERSION "2021.10.0"' installer.nsi # branch 2021
rdm/build/windows/installer $ sed -i '/^Name "RESP/a\# version\n!define VERSION "2022.1.0"' installer.nsi # branch 2022

请注意此处VERSION必须定义写成’x.x.x’这样的格式。不然NSIN在打包过程中就会报错：

Processed 1 file, writing output (x86-unicode):
Adding plug-ins initializing function... Done!
Error: invalid VIProductVersion format, should be X.X.X.X
Error - aborting creation process

通过两种打包方式可以看出NSIN的压缩比例明显占优，就看各自喜好。我个人喜欢noinstaller