基于openresty用lua搭建短网址服务

目标：能够基于openresty用lua+redis搭建短网址服务。

读者：要求有一定的web开发基础。

2. 准备工作

硬件环境

• PC或笔记本：1台
• 云服务器：1台

软件工具

• OS: windows10-64bit，CentOS7-64bit
• web平台：openresty
• 缓存：redis
• IDE：Vscode

PS: 工具名称链接到官网，本文所需资源网盘下载地址(提取码：skmq)。

3. 本地(windows)开发环境搭建

web平台(openresty)

下载及安装

从官网或网盘下载zip解压安装包(如：openresty-1.15.8.3-win32.zip)，然后解压到某个盘符下(如：D:\)。PS: 因luarocks目前仅有32bit的编译发布包。

双击安装目录(如: D:\openresty-1.15.8.3-win32)下"nignx.exe"运行，将会出现如下界面,说明安装正常。PS: 若有必要请安装perl。

启停

编写启停脚本存放在安装目录下.

启动脚本start.bat:

::start.bat
nginx.exe -c conf/nginx.conf

停止脚本stop.bat:

::stop.bat
nginx -s stop 
taskkill /F /IM nginx.exe > nul 

双击start.bat启动，双击stop.bat停止。

配置

默认是使用安装目录下的conf/nginx.conf，若有必要，按实际需求进行修改即可。每次修改配置后，请重启程序或重加载配置(nginx -s reload)。 如: 发布f:/dwz网站

  location / {
    root f:/git/dwz;
    index index.html index.htm;
  }

安装gcc(mingw)、cmake环境安装

下载及安装: mingw-w64|MinGW cmake .下载后直接解压到d:\或安装并配置系统环境：

MINGW32_HOME=d:\mingw-w64\mingw32 
MINGW_HOME=%MINGW32_HOME% 
CMAKE_HOME32=d:\cmake-3.17.1-win32-x86 
CMAKE_HOME64=d:\cmake-3.17.1-win64-x64 
CMAKE_HOME=%CMAKE_HOME32% 
path=%MINGW_HOME%\bin;%CMAKE_HOME%\bin;%path%

安装luarocks及依赖库

下载及安装:

下载all-in-one包 latest win32.zip file here，然后解压到d:\，然后执行install进行安装：

cd /d d:\luarocks-3.3.1-win32\ 
set PREFIX=d:\openresty-1.15.8.3-win32 
install /P %PREFIX%\luarocks /SELFCONTAINED /INC %PREFIX%\include\luajit-2.1 /LIB  %PREFIX% /BIN %PREFIX% /MW

配置系统环境变量:

OPENRESTY_HOME=D:\openresty-1.15.8.3-win32  ##luajit.exe
RESTY_LUAROCKS_SYSTREE=D:\openresty-1.15.8.3-win32/luarocks/systree
LUA_VERSION=5.1
LUA_PATH=%OPENRESTY_HOME%\lua\?.lua;%OPENRESTY_HOME%\lualib\?.lua;%RESTY_LUAROCKS_SYSTREE%\share\lua\%LUA_VERSION%\?.lua LUA_CPATH=?.dll;?/?.dll;%OPENRESTY_HOME%\lualib\?.dll;%OPENRESTY_HOME%\lualib\?.so;%RESTY_LUAROCKS_SYSTREE%\lib\lua\%LUA_VERSION%\?.dll

安装依赖lua库:

##启动cmd窗口
cd /d %OPENRESTY_HOME%\luarocks
D:\openresty-1.15.8.3-win32\luarocks>luarocks install bit32
D:\openresty-1.15.8.3-win32\luarocks>luarocks install struct
D:\openresty-1.15.8.3-win32\luarocks>luarocks install lua-cjson
D:\openresty-1.15.8.3-win32\luarocks>luarocks list
Rocks installed for Lua 5.1
---------------------------
bit32
   5.3.0-1 (installed) - d:/openresty-1.15.8.3-win32/luarocks/systree/lib/luarocks/rocks-5.1
lua-cjson
   2.1.0.6-1 (installed) - d:/openresty-1.15.8.3-win32/luarocks/systree/lib/luarocks/rocks-5.1
struct
   1.4-1 (installed) - d:/openresty-1.15.8.3-win32/luarocks/systree/lib/luarocks/rocks-5.1

缓存(redis)

下载及安装

从redis微软发布官网或网盘下载zip解压安装包(如：Redis-x64-3.2.100.zip)，然后解压到某个盘符下(如：D:\)，双击安装目录(如: D:\Redis-x64-3.2.100)下"redis-server.exe"运行，将会出现如下界面,说明安装正常。

启停

编写启停脚本存放在安装目录下.

启动脚本start.bat:

::start.bat
redis-server.exe redis.windows.conf

停止脚本stop.bat:

::stop.bat
taskkill /F /IM redis-server.exe > nul 

双击start.bat启动，双击stop.bat停止。

配置

默认是使用安装目录下的redis.windows.conf，若有必要，按实际需求进行修改即可。每次修改配置后，请重启程序。如: 仅本机且密码访问

bind 127.0.0.1
requirepass %FSIh$qcnoYwGQvN

IDE(Vscode)

下载及安装

从官网或网盘下载zip解压安装包(如：VSCode-win32-x64-1.44.1.zip)，然后解压到某个盘符下(如：D:\VSCode-win32-x64)，双击安装目录(如: D:\VSCode-win32-x64)下"code.exe"运行。

下载及安装Lua插件

启动vscode后，按"Ctrl+Shift+X"，输入lua, 选中"Lua 0.18.1"，点击右下角的Install完成安装。如下图:

PS: 插件Code Runner，方便调试代码段.

4. 短网址开发与调试

设计思路

短网址的目的是将长网址转换为较短的网址，从而方便记忆或使用。目前比较多的是t.cn和url.cn的短网址服务，功能比较完善且成熟，但都收费。故设计一个最简单的短网址服务：仅提供长短转换及短网址访问功能。

最简单的转换方法就是对长网址做HASH、MD5、CRC等处理获取唯一值，然后进行<K,V>存储，最后提供基于K的访问短网址。

考虑到效率问题，经过收集资料甄比筛选，决定使用MurmurHash3+Redis来实现简单的长短网址的转换和存储，openresty+lua来实现此功能。

主要编码

dwz/murmurhash3.lua: 实现hash算法模块。具有一定的高效性、稳定性、防碰撞性。

dwz/base62.lua: 实现10与62进制的转换模块。支持自定义62进制字符串序。

dwz/redis-mg.lua: redis操作的简单封装。

dwz/init.lua: 长短网址转换和存储模块。

access_by_redis.lua: 基于访问IP的限流和短网址服务功能。

本地调试

修改openresty的配置文件conf/nginx.conf，然后重启或重加载配置：

   error_log logs/error.log debug;
   http {
      # load lua modules  env.LUA_{PATH,CPAHT}
      lua_code_cache off;  ##only debug
      lua_package_path        "f:/git/dwz/lua/?.lua;f:/git/dwz/?/?.lua;f:/git/dwz/lua/?/init.lua;;";
   }
   server {
      access_by_lua_file "f:/git/dwz/lua/access_by_redis.lua";
      location /dwz/ {
         alias f:/git/dwz/;
         index index.html
         error_page   404  /dwz/404.html;
      }
   }

然后在浏览器(建议chrome)地址栏输入地址后回车: 长网址转短网址：localhost/dwz/${由encodeURIComponent编码的长网址}，将返回json数据(包括原长网址和目标短网址) 短网址访问：localhost/dwz/${hashkey} 若出现访问异常，请查看openresty的日志文件logs/error.log。

5. 短网址部署发布

发布环境搭建

购买一台云服务器，安装CentOS7，然后yum安装redis、openresty，再安装luarocks及依赖库且配置环境变量：

##配置openresty安装域名源
restyRepo(){
cat << RESTY
[openresty]
name=Official OpenResty Open Source Repository for CentOS
baseurl=https://openresty.org/package/centos/$releasever/$basearch
skip_if_unavailable=False
gpgcheck=1
repo_gpgcheck=0
gpgkey=https://openresty.org/package/pubkey.gpg
enabled=1
enabled_metadata=1
RESTY
}
restyRepo > /etc/yum.repos.d/openresty.repo

##yum安装redis openresty
yum makecache
yum install -y redis openresty

##安装luarocks及依赖库
#从 http://www.luarocks.org/en/Download 下载最新版本的 LuaRocks源码进行安装
cd /opt
wget http://luarocks.org/releases/luarocks-3.3.1.tar.gz
tar -xzvf luarocks-3.3.1.tar.gz
cd luarocks-3.3.1
OPENRESTY_HOME=/usr/local/openresty
./configure --prefix=${OPENRESTY_HOME}/luarocks --with-lua=${OPENRESTY_HOME}/luajit 
make && make install 
#设置lua搜索路径
echo '##openresty && luarocks ' >> /etc/profile
echo 'export OPENRESTY_HOME=/usr/local/openresty ' >> /etc/profile
echo  'eval `${OPENRESTY_HOME}/luarocks/bin/luarocks path`' >> /etc/profile
source /etc/profile
#安装lua库  
luarocks install struct
luarocks list

短网址部署发布

将本地调试好的程序打包(dwz.zip)，上传到云服务器上，并解压到某个目录下(如：/opt/myweb)，再修改openresty的配置文件，最后重启openresty服务。

##部署发布包dwz.zip
cd /opt/myweb; unzip dwz.zip
#修改openresty的配置
cd /usr/local/openresty/nginx/conf/conf.d
ln -s /opt/myweb/dwz/nginx-dwz.conf dwz.conf
#测试配置并重启openresty
openresty -t
service openresty restart

若一切正常，在浏览器中输入：{云服务器外网IP}:8000/,出现界面如下：

6. 短网址服务用法

长网址转短网址用法：

在浏览器地址栏中输入: http://{IP}:8000/dwz/${长网址} 后回车即可。 PS: ${长网址}必须由encodeURIComponent编码。 如：https://www.wiqi100.cn/dwz/https%3A%2F%2Fwww.wiqi100.cn%2Fportal%2Findex.html%3Fp%3D中文%26p1%3Dv1%2Bv2%2B值20200615

短网址使用方法：

将短网址直接复制到浏览器的地址栏即可. 如：https://www.wiqi100.cn/dwz/uAi00n

7. 结束语

基于openresty用lua搭建的短网址服务，为自己的网站提供一个可用的短网址功能，方便自己方便大家。

因本人水平有限，文中难免会有错误或不足之处，望各位看官不吝赐教。

8. 参考资料

由衷感谢，基于各官网和网上搜索的一些相关资料，本文不再一一列出。