luck-base-dingtalk

介绍

钉钉对接基础服务，对外提供群消息和个人通知等接口信息。

软件架构

软件架构说明

• 项目名
  • app
    • imgs 图片文件夹
    • works Docker映射目录
      • logs 日志文件夹
        • Luck.log 日志文件
      • Luck.db 数据库文件
      • LuckConfig.json 配置文件
    • LuckDbHelperUtils.py 数据库辅助类
    • LuckApi.py 钉钉Api
    • LuckConstant.py 常量类
    • LuckMain.py 启动入口
    • LuckService.py 逻辑服务层
    • LuckLogService.py 日志逻辑服务层
    • LuckDeptService.py 部门逻辑服务层
    • LuckUserService.py 用户逻辑服务层
    • requirements.txt 引用库管理文件
    • LuckMain.service Linux服务制作文件
  • Dockerfile # 构建镜像文件
  • README.md # 说明文件

安装教程

1 准备工作

• 调整配置文件内容

打开LuckConfig.json文件，调整下面的内容

{
  "server_port": 5001, # 服务启动端口号
  "basic_auth1": "admin", # 认证鉴权账号
  "basic_auth2": "luckserver" # 认证鉴权密码
  
   # 钉钉认证信息
  "agent_id": 804578772, 
  "app_key": "dingkwmfrbsv0cencgb9",
  "app_secret": "_OVByoifueYAH0X6mAQjleWfgFhB0cfZ3v4MNgAHrfjYG-a_u4ULXbN9ujdpoVOe",

   # 数据存储信息
  "db_type": "mysql",
  "db_host": "10.10.10.231",
  "db_port": 3306,
  "db_name": "luck_base_log",
  "db_user": "root",
  "db_password": "123456",
  
  # 日志认证信息
  "log_app_key": "7f829251-197d-4117-b894-4b3220c7c9e5",
  "log_app_secret": "7d54f3fe-9b84-4b5b-a967-84d07772aa94",
  "log_url": "http://10.10.10.166:30753",
  "log_url_basic_auth1": "admin",
  "log_url_basic_auth2": "luckserver"
}

• 复制代码到服务器

示例目录：/home/luckyun/luck-base-dingtalk

2 python3环境准备

2.1 检测是否已安装python3

python3 --version

python3安装成功，下面的步骤可忽略

2.2 安装python3

• 安装Python的最新版本 sudo yum install python3

• 安装完成之后，可以使用命令检测安装是否成功 python3 --version

2.3 设置python软链接

这里一般不需要设置，可以忽略。

备注：如果需要设置python软链接，可按照下面的步骤操作

• 先删除默认的Python软链接： sudo rm -rf /usr/bin/python

• 然后创建一个新的软链接指向需要的Python版本

sudo ln -s /usr/bin/python3 /usr/bin/python
sudo ln -s /usr/bin/pip3 /usr/bin/pip

• 如果想还原回原python2.7，不还原，下面的命令就不要执行

sudo rm -rf /usr/bin/python
sudo ln -s /usr/bin/ptyhon2.7 /usr/bin/python

3 安装依赖

3.1 使用命令安装依赖

pip3 install -r requirements.txt -i https://pypi.tuna.tsinghua.edu.cn/simple

3.2 安装不成功的，可以单独安装

psutil可能会安装不成功，这个时候不要着急，按照下面的步骤来操作

• 方案一

将psutil-5.9.6.tar.gz上传到对应的文件中
解压：tar zxvf psutil-5.9.6.tar.gz
进入目录：cd psutil-5.9.6
安装插件：yum -y install python-devel （如果提示缺少python.h头文件，执行此命令。）
安装psutil：python3 setup.py install

• 方案二（推荐此方案）
  • Ubuntu / Debian

  sudo apt-get install gcc python3-dev
  pip install --no-binary :all: psutil
  • RedHat / CentOS

  sudo yum install gcc python3-devel
  pip install --no-binary :all: psutil
  • Alpine

  sudo apk add gcc python3-dev
  pip install --no-binary :all: psutil

4 制作服务启动

4.1 复制service文件至system目录下

将服务文件LuckMain.service存放到下面的目录 /etc/systemd/system

4.2 服务文件变动，需要重新加载systemd配置，没有就不执行

sudo systemctl daemon-reload

4.3 启动服务

sudo systemctl start LuckMain.service

4.4 检查服务的状态

sudo systemctl status LuckMain.service

4.5 设置自动启动服务

sudo systemctl enable LuckMain.service

4.6 停止服务

sudo systemctl stop LuckMain.service

4.7 重启服务

sudo systemctl restart LuckMain.service

5 开放端口号

按照下面的操作步骤执行命令：

firewall-cmd --permanent --add-port=5001/tcp
firewall-cmd --reload

使用说明

1. 服务启动成功
2. 浏览器输入 http://127.0.0.1:5001/, 验证服务部署状态

注意：10.10.10.167要根据实际情况而定。

{
	"code": 1,
	"data": ["/", "/sendLinkMsgToGroup", "/sendTextToGroup", "/sendFeedcardMsgToGroup", "/sendActioncardMsgToPerson", "/sendLinkMsgToPerson", "/sendTextMsgToPerson", "/createTable", "/deleteTable", "/dropTable"],
	"msg": "钉钉服务部署成功"
}

疑难杂症

问题一

问题二

参与贡献

1. Fork 本仓库
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request

特技

1. 使用 Readme_XXX.md 来支持不同的语言，例如 Readme_en.md, Readme_zh.md
2. Gitee 官方博客 blog.gitee.com
3. 你可以 https://gitee.com/explore 这个地址来了解 Gitee 上的优秀开源项目
4. GVP 全称是 Gitee 最有价值开源项目，是综合评定出的优秀开源项目
5. Gitee 官方提供的使用手册 https://gitee.com/help
6. Gitee 封面人物是一档用来展示 Gitee 会员风采的栏目 https://gitee.com/gitee-stars/