Lua 包管理 – Luarocks 使用指南

Lua 包管理 - Luarocks 使用指南

  • 一、luarocks 介绍
  • 二、安装配置 luarocks
    • 1. 准备lua环境
      • 1.1 下载可Lua执行文件
      • 1.2 下载Lua库文件
      • 1.3 解压
    • 2. C/C++编译环境
    • 3. 下载luarocks && 安装
    • 4. 配置luarocks,指定lua环境目录
  • 三、使用luarocks
    • 3.1. 使用luarocks 安装库
    • 3.2 查看rock
    • 3.3 卸载已经安装的库
  • 四、开发Luarocks库
    • 4.1 创建 luarocks 项目
    • 4.2 安装本地项目
    • 4.3 运行项目测试
    • 4.4 上传

注 :

本文主要基于windows平台进行讲解,Linux 下的操作类似(并且相关的文章很多)

本文简要说明一些常用操作,具体可参看 官方文档 : https://github.com/luarocks/luarocks/wiki/Documentation

一、luarocks 介绍

Luarocks 是一个下载、管理lua的第三方包的命令行工具。

  • 支持本地和远程存储库。
  • 安装第三方包,一键式安装。(包中如果使用到C库,会在安装的时候使用编译器进行构建)

二、安装配置 luarocks

1. 准备lua环境

1.1 下载可Lua执行文件

Lua53可执行文件
在这里插入图片描述

1.2 下载Lua库文件

lua动态库
在这里插入图片描述

1.3 解压

把上面下载文件 解压到一个目录
[可选] :将目录加入环境变量Path, 方便在控制台直接使用 Lua

2. C/C++编译环境

这个作为开发人员应该是有的,VisualStudio / MinGW 均可

注:
这个其实不是必须的,主要看你需要使用的第三方Lua库,如果库是C库 那么luarocks在安装库时需要编译

3. 下载luarocks && 安装

http://luarocks.github.io/luarocks/releases/
在这里插入图片描述
将存放解压后文件的目录添加到环境变量 Path 中, 方便直接在命令行使用 luarocks
设置好后 重启计算机使环境变量生效

4. 配置luarocks,指定lua环境目录

作者的lua环境目录是:E:\Lua\lua53X64
后面均以这个为例

1
luarocks config lua_dir E:\Lua\lua53X64

执行后 显示

1
2
3
4
5
6
7
8
Wrote
        lua_interpreter = "lua53.exe"
        variables.LUA_BINDIR = "E:\\Lua\\lua53X64"
        variables.LUA_DIR = "E:\\Lua\\lua53X64"
        variables.LUA_INCDIR = "E:\\Lua\\lua53X64/include"
        variables.LUA_LIBDIR = "E:\\Lua\\lua53X64"
to
        C:/Users/name/AppData/Roaming/luarocks/config-5.3.lua

注:

  • 这一步如果报错,需要在C:/Users/name/AppData/Roaming/ 手动创建一个 luarocks 文件夹
  • 另外可以根据实际情况分别指定不同的环境值 比如 LUA_INCDIR 等

三、使用luarocks

3.1. 使用luarocks 安装库

以安装 luasocket 为例,luasocket 中包含c代码,作者使用 VS 作为编译器

  • 运行VS X64 控制台

    在这里插入图片描述

  • 执行命令 luarocks install luasocket
    默认会把lua包安装在 C:\Users\Administrator\AppData\Roaming/luarocks
    其实可以指定 包的安装目录,如安装在 G:\test,可以执行 luarocks --tree=G:\test install luasocket
    指定目录安装为例,运行结果如下:
    在这里插入图片描述
    在这里插入图片描述

3.2 查看rock

luarocks show --tree=G:\test luasocket
查看刚刚安装的 luasocket
在这里插入图片描述

3.3 卸载已经安装的库

luarocks remove --tree=G:\test luasocket

在这里插入图片描述

四、开发Luarocks库

如果你想开发一个 lua 库,托管在 Luarocks 给别的开发者使用,或者参与别人的一些开源库项目。Luarocks 工具本身提供了很多支持。

4.1 创建 luarocks 项目

1
2
cd G:\TestDev
luarocks init TestLib 1.0

在这里插入图片描述

在这里插入图片描述

4.2 安装本地项目

luarocks --tree=G:\Test make

在这里插入图片描述
这个命令可以方便在开发过程中构建并且安装在本地使用

4.3 运行项目测试

luarocks test
运行项目的单元测试,测试规则和依赖可以在 rockspec 文件中指定

4.4 上传

luarocks upload

这个命令需要用到密钥,可以注册Luarocks账号 获得