2021-09-09

路由设备管理软件开发总结

需求概要

该软件其目的为一个网关设备提供远程管理GUI，设备系统为Linux系统，原生系统只能提供命令行操作，对于一般用户不太友好，所以需要开发一款简单的具有用户界面的软件。

软件需实现以下功能：

1. 远程连接设备；
2. IP 配置；
3. 防火墙配置；
4. 路由(route)配置；
5. 其他(如VPN)服务配置；
6. 实现工具ping、telnet并运行在远程设备端。

需求分析

除了上述功能需求以外，需要考虑软件面向的用户，是普通用户，他们对这些路由、防火墙等概念和原理并不完全了解，因此在配置过程中难免会遇到困难，甚至一个错误的配置会让系统陷入崩溃，当然这也是系统设计应该考虑的问题。在此，本设备管理软件是面向用户的最前端，也是系统保护的第一道防线，因此不得不担负起双重责任：

1. 提供简单易用的用户向导，引导非专业用户完成陌生系统的配置；
2. 提供标准的输入方式，限制用户可能的错误操作，实现保护系统。

以上是界面交互设计的原则。提供准确的提示信息，指引用户操作。尽量限制用户的操作自由度，比如参数尽量格式化，IP地址输入框利用Regex进行格式限定，参数限制输入范围；提供默认建议设置等。

技术方案

采用Qt5.9，可以实现跨平台；
远程链接采用ssh 链接，采用现有的libssh库，关于libssh库的下载和编译见下文。

开发环境搭建

• 其中libssh下载，下载好后需要自行编译。编译通过

  mkdir build
  cd build
  cmake ..
  make
  

• Windows 端可以通过以下命令安装：

  vcpkg install libssh
  

• 其中vcpkg 是Microsoft 为windows 提供的一个c/c++ 的开源包管理工具，见 github。
• 需要编译好的ssh.lib、ssh.dll和ssh.h 可以留言。

踩坑记录

1. 使用QTextEdit 作为用户操作日志显示，如下代码

	class ToolDialog:public QDialog{
	public:
		void showLog()
		{
			QSting msg;
			while(receive(msg))
			{
				ui->textEdit->append(msg);
			}
		}
	};

是从远程循环接收命令行消息，如执行ping命令后的中端信息。以上代码片段是在主循环中，有朋友可能会说这显然不行，其实我的这段代码是在一个弹出的模态对话框中，不介意阻塞其他界面的响应。可惜的是，还真不行。上述代码并不能将远程终端信息及时显示到界面中。

分析其原因，可能是上述在主循环中，while 循环占据了cpu 时间，阻塞了GUI 的事件循环，所以界面无法显示日志信息。可能你会想到添加sleep 函数强制让出cpu，其实也是无济于事，因为让出的cpu 时间也是让给了其他线程，GUI还是依然无法得到cpu 时间。

那么，就只能就将循环移入到工作线程中，Qt提供了方便的处理办法，创建一个工作线程接收远程设备消息，将while 代码段也就移入线程中的doWork 方法，然后利用信号发送出来。在ToolDialog中接收信号并显示到日志控件textEdit 中。这下应该可以了吧？

	//Worker
	class Worker:public QObject
	{
	void Worker(QObject *parent):QObject(parent){}
	void doWork()
	{
		QSting msg;
		while(receive(msg))
		{
			sendMsg(msg);
		}
	}
	signals:
	void sendMsg(const QString&msg);
	...
	};
	//GUI
	class ToolDialog:public QDialog{
	public:
	ToolDialog(QWidget*parent){
		m_thread = std::make_shared<Qthread>(this);
		m_worker =  std::make_shared<Qthread>(this);
		m_worker->moveToThread(m_thread);
		connect(m_threrad, &QThread::started, m_worker, &Worker::doWork);
		connect(m_worker, &Worker::sendMsg, this, [=](const QString &msg) {
			ui->textEdit->append(msg.trimmed());
		}, Qt::QueuedConnection);
		m_thread->start();
	}
	private:
	std::shared_ptr<QThread>m_thread;
	std::shared_ptr<Worker>m_worker;
};

其实不然，又不行，界面无任何响应，调试跟踪发现线程就未启动，m_thread->start() 就是启动线程的呀，观察输出窗口提示moveToThread执行失败，难道使用方法错误，只能查看帮助文档。文档中这样写道:Changes the thread affinity for this object and its children. The object cannot be moved if it has a parent. Event processing will continue in the targetThread. 找到答案了，也就是worker在转移到Thread 之前不能有parent，所以错误在于

	m_worker =  std::make_shared<Qthread>(this);

修改为：

	m_worker =  std::make_shared<Qthread>();

测试发现果然如此。
4. 在QTextEidt 为右键菜单添加快捷键时，修改多此代码，快捷键都无效。

void LogWidget::contextMenuEvent(QContextMenuEvent *event)
{
    QMenu *menu = createStandardContextMenu();
    QAction *action = menu->addAction(tr("Clear"));
    action->setShortcut(QKeySequence::Delete);
    //action->setShortcutContext(Qt::ApplicationShortcut);
    connect(action,&QAction::triggered,this,&QTextEdit::clear);
    menu->exec(event->globalPos());
    delete menu;
}

界面显示快捷键为Del，但是按键盘的Delete 键，无任务反应，鼠标点击可以工作。查看各大网站说是Qt 的bug，感谢有知道读者帮忙纠正。

经验总结

1. 在开发前做好流程设计；
2. 代码层次分明，各干其事情；
3. 开发中尽量使用English，如果需要中文，然后再做翻译，需要翻译的文本使用 tr("")。
   翻译过程：
   1. 跟新*.ts 文件，获取需要翻译的文本信息。
   2. 使用Qt Linguist 修改ts 文件。
   3. 最后使用发布翻译(lrelease)
   4. 添加代码，翻译完成。

   	QTranslator translator;
   	translator.load(":/*_zh_CN.qm");
   	qApp->installTranslator(&translator);
   

4. Windows 平台安装包制作工具Inno Setup。

暂时就写到这里，欢迎评论区留言！

感谢！