# luapb

**Repository Path**: brinkqiang/luapb

## Basic Information

- **Project Name**: luapb
- **Description**: Lua 内置模块实现了类似于 CMake 的模块化功能。它通过在模块内直接调用 Protobuf 的反射特性，实现了在 Lua 层面上的自动反射。该模块支持 Protobuf 2 和 Protobuf 3，并能实现 Protobuf、Lua table 与其他数据结构（如 XML、JSON、YAML）之间的转换。该模块已经通过了Mac , Windows, Linux 的编译测试。
- **Primary Language**: C++
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 8
- **Forks**: 2
- **Created**: 2019-08-08
- **Last Updated**: 2025-04-30

## Categories & Tags

**Categories**: utils

**Tags**: protobuf, Lua

## README

# luapb

Copyright (c) 2013-2018 brinkqiang (brink.qiang@gmail.com)

[![luapb](https://img.shields.io/badge/brinkqiang-luapb-blue.svg?style=flat-square)](https://github.com/brinkqiang/luapb)
[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://github.com/brinkqiang/luapb/blob/master/LICENSE)
[![blog](https://img.shields.io/badge/Author-Blog-7AD6FD.svg)](https://brinkqiang.github.io/)
[![Open Source Love](https://badges.frapsoft.com/os/v3/open-source.png)](https://github.com/brinkqiang)
[![GitHub stars](https://img.shields.io/github/stars/brinkqiang/luapb.svg?label=Stars)](https://github.com/brinkqiang/luapb) 
[![GitHub forks](https://img.shields.io/github/forks/brinkqiang/luapb.svg?label=Fork)](https://github.com/brinkqiang/luapb)

## Build status
| [Linux][lin-link] | [Mac][mac-link] | [Windows][win-link] |
| :---------------: | :----------------: | :-----------------: |
| ![lin-badge]      | ![mac-badge]       | ![win-badge]        |

[lin-badge]: https://github.com/brinkqiang/luapb/workflows/linux/badge.svg "linux build status"
[lin-link]:  https://github.com/brinkqiang/luapb/actions/workflows/linux.yml "linux build status"
[mac-badge]: https://github.com/brinkqiang/luapb/workflows/mac/badge.svg "mac build status"
[mac-link]:  https://github.com/brinkqiang/luapb/actions/workflows/mac.yml "mac build status"
[win-badge]: https://github.com/brinkqiang/luapb/workflows/win/badge.svg "win build status"
[win-link]:  https://github.com/brinkqiang/luapb/actions/workflows/win.yml "win build status"

## Intro
luapb  

win
```
build.bat
cd bin\relwithdebinfo
lua ..\script\msg.lua  
```
linux
```
bash build.sh
cd bin/relwithdebinfo
./lua ../script/msg.lua  
```

```
pb_import enter
pb_import leave
pbtest 1361563254513615632545@163.com (2first2second2three
```

```lua
local pb = require("luapb")
local luajson = require("luajson")

pb.import("net.proto")

local name = pb.id2name(8345))
local id = pb.name2id("net.tb_Person"))

local msg = pb.pb_new("net.tb_Person")

msg.number = "13615632545"
msg.email = "13615632545@163.com"
msg.age = 28
msg.ptype = 2
msg.desc:add("first")
msg.desc:add("second")
msg.desc:add("three")

local msg_debugstring = pb.tostring(msg)

local buffer = pb.serializeToString(msg)

local msg2 = pb.new("net.tb_Person")
pb.parseFromString(msg2, buffer)

local tb_msg = {
    number = "13615632545",
    email = "13615632545@163.com",
    age = 28,
    ptype = "WORK",
    desc = {"first", "second", "three"},
    jobs = {
        {
            jobtype = 8345,
            jobdesc = "coder"
        },
        {
            jobtype = 9527,
            jobdesc = "coder2"
        }
    }
}

local buffer2 = pb.encode("net.tb_Person", tb_msg)
local tb_msg2 = pb.decode("net.tb_Person", buffer2)

local str_json = pb.table2json("net.tb_Person", tb_msg2)
local str_xml = pb.table2xml("net.tb_Person", tb_msg2)
local str_yaml = pb.table2yaml("net.tb_Person", tb_msg2)

local tb_json = pb.json2table("net.tb_Person", str_json)
local tb_xml = pb.xml2table("net.tb_Person", str_xml)
local tb_yaml = pb.yaml2table("net.tb_Person", str_yaml)

```
## Contacts

## Thanks