FAQ问答系统

采用了微服务架构，是对单体架构的升级。

项目采用了Spring Boot,Spring Cloud Alibaba,MyBatis等核心技术，同时提供了前端界面用于访问系统。

系统架构图

组织结构

faq-qa-sys-v2
├── gateway                 -- 基于Spring Cloud Gateway的微服务API网关服务
├── microservice-dialogue   -- 对话微服务
└── microservice-management -- 管理微服务

项目功能

对话系统

对话系统已实现的功能如下：

• 单轮/多轮问答
• 记录未识别问题
• 历史记录
• 收集用户反馈

管理系统

管理系统已实现的功能如下：

• 全量同步
• 批量导入问答对/相似问对
• 更新问答对/相似问对
• 删除问答对/相似问对
• 记录未识别问题

技术选型

数据库

后端

工具中间件

前端

环境搭建

开发环境

搭建步骤

JDK

关于JDK的配置可参考该教程

Redis

关于Redis的下载安装和启动可参考该教程

Elasticsearch6.x(6.8.13)

1. 关于Elasticsearch6.x的下载安装和启动可参考该教程

  #cd到es目录
  bin/elasticsearch

2. 配置中文分词插件

下载和es对应版本的ik分词插件，解压里面的内容到es根目录的plugins/ik

新建用户自定义词典data/dictionary/user_word.dic放在es根目录的plugins/ik/config/user_word.dic

user_word.dic内容示例如下（一个自定义词一行）：

兰陵王入阵曲

然后在用户自定义词典的统计目录下，修改ik配置vim IKAnalyzer.cfg.xml

    <!--用户可以在这里配置自己的扩展字典 -->
    <entry key="ext_dict">user_word.dic</entry>

3. 配置同义词库

新建同义词库data/dictionary/synonym.txt放在es根目录的config/analysis/synonym.txt

synonym.txt内容示例如下（使用最简单的表达形式）

jump,leap,hop

如果遇到这些词项中的任何一项，则将其替换为所有列出的同义词。关于其他同义词形式参考官方文档

MySQL

1. 关于MySQL的下载安装和启动可参考该教程

2. 启动成功后，通过命令use qadb; 进入qadb数据库，若没有可通过如下语句创建

CREATE DATABASE IF NOT EXISTS qadb DEFAULT CHARSET utf8 COLLATE utf8_general_ci;

3. 导入项目根目录下/sql/qadb.sql，将在qadb数据库中创建4张表stdq_stda和stdq_simq，feedback和history，使用以下命令导入

source qadb.sql;

Nginx

Nginx是高性能的Web和反向代理服务器 ，关于Nginx的安装配置可参考该教程

  #cd到nginx目录，启动
  sudo sbin/nginx -c conf/nginx.conf
  #cd到nginx目录，平滑重启
  sudo sbin/nginx -c conf/nginx.conf -s reload

1. 拦截静态页面

    # 编辑nginx.conf
   server {
        listen       8600;
        server_name  localhost;
        # 配置对话页面的请求路由
        location /qa-ui {
            alias /home/lca/code/ui/qa-ui/;
            index dialogue.html;
        }
    }

2. 转发其他请求

   server {
        listen       8600;
        server_name  localhost;
        # 转发其他请求到服务网关
        location / {
            proxy_pass http://localhost:8900;
            proxy_set_header Host $http_host;
            proxy_set_header X-Real-IP $remote_addr;
            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
            proxy_http_version 1.1;
            proxy_set_header Connection "";
        }
    }

3. 配置相似度服务代理

    # 假定启动两个相似度模型服务，端口号分别为6661和6662，weight表示访问权重
    upstream sim_server {
        server localhost:6101 weight=1;
        server localhost:6102 weight=1;
        keepalive 30;
    }
    # 6100端口的/sim请求将被转发到sim_server上
    server {
        listen       6100;
        server_name  localhost;
        # 转发其他请求到服务网关
        location /sim {
            proxy_pass http://sim_server;
            proxy_set_header Host $http_host;
            proxy_set_header X-Real-IP $remote_addr;
            proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
            proxy_http_version 1.1;
            proxy_set_header Connection "";
        }
    }

重启nginx，可通过localhost:8600/qa-ui访问对话页面

Nacos Server

搭建Nacos Server,可参考官方文档

1. 下载和Spring Cloud Alibaba版本对应的Nacos

2. 启动服务器

       # Linux/Unix/Mac 启动命令(standalone代表着单机模式运行，非集群模式):
       sh startup.sh -m standalone
       
       # 如果您使用的是ubuntu系统，或者运行脚本报错提示[[符号找不到，可尝试如下运行：
       bash startup.sh -m standalone
       
       # Windows启动命令(standalone代表着单机模式运行，非集群模式):
       startup.cmd -m standalone

3. 访问localhost:8848/nacos，使用nacos/nacos登陆控制台

Sentinel Dashboard

1. 下载Sentinel控制台Dashboard

2. 启动控制台java -jar sentinel-dashboard.jar，启动成功后通过浏览器访问localhost:8080，使用sentinel/sentinel登陆

RocketMQ

1. 下载RocketMQ，按照官方文档启动Name Server和Broker

  #启动name server
  sh bin/mqnamesrv
  #启动broker
  sh bin/mqbroker -n localhost:9876

2. 下载控制台源码

   1. 用IDE打开rocketmq-console，编辑配置文件application.properties

   # console端口
   server.port=17890
   # nameserver地址
   rocketmq.config.namesrvAddr=localhost:9876
   2. 修改pom依赖

   在pom.xml中找到该行，修改版本为你rocketmq的版本

      <rocketmq.version>4.8.0</rocketmq.version>
   3. 打包

   进入rocketmq-console目录，输入下面命令

      mvn clean package -Dmaven.test.skip=true
   4. 启动

   进入target目录，启动jar

      java -jar rocketmq-console-ng-2.0.0.jar
   5. 访问控制台

   通过浏览器访问localhost:17890/#/

项目启动

确保在上一步骤已经完成了环境的搭建，接下来分别启动相似度服务、网关服务、对话微服务和管理微服务

相似度服务启动

关于相似度服务的启动参考readme

网关服务启动

关于网关服务的启动参考readme

对话微服务启动

关于对话微服务的启动参考readme

管理微服务启动

关于管理微服务的启动参考readme

附录

前端演示UIQA-UI

关于开发过程中的微服务技术的整合、配置步骤，参考这里