gojs

gojs

A high-performance JavaScript runtime library based on goja, designed for Go applications. Features script caching, concurrent execution, and rich built-in libraries.

一个基于 goja 的高性能 JavaScript 运行时库，专为 Go 应用程序设计。支持脚本缓存、并发执行、丰富的内置库。

English | 中文

Features

• High Performance: Based on goja engine with script pre-compilation and caching support
• Concurrent Safe: Supports multi-goroutine concurrent script execution
• Rich Built-in Libraries: Integrated lodash, moment.js, CryptoJS, xml-js, formulajs, etc.
• Buffer Extensions: Supports BigInt64/BigUInt64 read/write operations
• CRC Checksum: Supports CRC16/CRC32/CRC64/Modbus CRC checksums
• Compression: Supports gzip and zip decompression
• Encoding Conversion: Supports iconv encoding conversion
• Logging Integration: Supports structured logging output

Installation

go get github.com/felix-186/gojs

Quick Start

Basic Usage

package main

import (
    "fmt"
    "github.com/felix-186/gojs"
)

func main() {
    script := `
    function handler(input) {
        return _.map(input, function(x) { return x * 2; });
    }
    `

    result, err := gojs.Run(script, []interface{}{1, 2, 3, 4, 5}...)
    if err != nil {
        panic(err)
    }
    fmt.Println(result.Export()) // [2, 4, 6, 8, 10]
}

Using Cache

// Cache script with ID
result, err := gojs.RunByIdAndScript("my-script-id", script, args...)

// Execute cached script
_, err := gojs.GetJsVm("my-script", script)
result, err := gojs.RunById("my-script", args...)

API Reference

Core Functions

Buffer Operations

Utility Functions

Built-in Libraries

Buffer Extensions

// BigInt64 read/write
buffer.writeBigInt64LE(value, offset);
buffer.writeBigInt64BE(value, offset);
buffer.readBigInt64LE(offset);
buffer.readBigInt64BE(offset);

// BigUInt64 read/write
buffer.writeBigUInt64LE(value, offset);
buffer.writeBigUInt64BE(value, offset);
buffer.readBigUInt64LE(offset);
buffer.readBigUInt64BE(offset);

CRC Checksum

crc.checksum16(buffer, poly);      // CRC16
crc.checksum32(buffer, poly);      // CRC32
crc.checksum64(buffer, poly);      // CRC64
crc.checksumModbus(buffer);        // Modbus CRC

API Library

apilib.SleepMill(1000);           // Sleep (milliseconds)
apilib.UnGzip(gzipData);           // Decompress gzip
apilib.Unzip(zipData);             // Decompress zip

Logging

logger.Debug("debug message", 1);
logger.Info("info message", 2);
logger.Warn("warn message", 3);
logger.Error("error message", 4);

Examples

Data Processing

script := `
function handler(data) {
    return _.map(data, function(item) {
        return {
            id: item.id,
            value: item.value * 2,
            timestamp: moment().format('YYYY-MM-DD HH:mm:ss')
        };
    });
}
`

data := []map[string]interface{}{
    {"id": "1", "value": 10},
    {"id": "2", "value": 20},
}

result, err := gojs.Run(script, data)

Encryption

script := `
function handler(text) {
    var encrypted = CryptoJS.AES.encrypt(text, "secret-key").toString();
    var decrypted = CryptoJS.AES.decrypt(encrypted, "secret-key").toString(CryptoJS.enc.Utf8);
    return { encrypted: encrypted, decrypted: decrypted };
}
`

XML Conversion

script := `
function handler(xmlString) {
    return xmlJs.xml2json(xmlString, { compact: true });
}
`

Performance

Script Caching

// First execution compiles and caches
gojs.RunByIdAndScript("script-1", script, data...)

// Subsequent executions use cache
gojs.RunById("script-1", data...)

Concurrent Execution

var wg sync.WaitGroup
for i := 0; i < 100; i++ {
    wg.Add(1)
    go func(idx int) {
        defer wg.Done()
        result, _ := gojs.RunById("script-1", idx)
    }(i)
}
wg.Wait()

Error Codes

Testing

# Run all tests
go test ./...

# Run with coverage
go test -cover ./...

# Generate coverage report
go test -coverprofile=coverage.out ./...
go tool cover -html=coverage.out

# Run benchmarks
go test -bench=. ./...

Dependencies

• goja - JavaScript interpreter
• goja_nodejs - Node.js compatibility modules
• go-cache - In-memory cache

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

MIT License

特性

• 高性能: 基于 goja 引擎，支持脚本预编译和缓存
• 并发安全: 支持多 goroutine 并发执行脚本
• 内置库丰富: 集成 lodash、moment.js、CryptoJS、xml-js、formulajs 等常用库
• Buffer 扩展: 支持 BigInt64/BigUInt64 读写操作
• CRC 校验: 支持 CRC16/CRC32/CRC64/Modbus CRC 校验
• 压缩解压: 支持 gzip、zip 格式的压缩解压
• 编码转换: 支持 iconv 编码转换
• 日志集成: 支持结构化日志输出

安装

go get github.com/felix-186/gojs

快速开始

基本使用

package main

import (
    "fmt"
    "github.com/felix-186/gojs"
)

func main() {
    script := `
    function handler(input) {
        return _.map(input, function(x) { return x * 2; });
    }
    `

    result, err := gojs.Run(script, []interface{}{1, 2, 3, 4, 5}...)
    if err != nil {
        panic(err)
    }
    fmt.Println(result.Export()) // [2, 4, 6, 8, 10]
}

使用缓存执行

// 使用 ID 缓存脚本
result, err := gojs.RunByIdAndScript("my-script-id", script, args...)

// 使用已有缓存执行
_, err := gojs.GetJsVm("my-script", script)
result, err := gojs.RunById("my-script", args...)

API 文档

核心函数

Buffer 操作

工具函数

内置库

Buffer 扩展方法

// BigInt64 读写
buffer.writeBigInt64LE(value, offset);
buffer.writeBigInt64BE(value, offset);
buffer.readBigInt64LE(offset);
buffer.readBigInt64BE(offset);

// BigUInt64 读写
buffer.writeBigUInt64LE(value, offset);
buffer.writeBigUInt64BE(value, offset);
buffer.readBigUInt64LE(offset);
buffer.readBigUInt64BE(offset);

CRC 校验

crc.checksum16(buffer, poly);      // CRC16
crc.checksum32(buffer, poly);      // CRC32
crc.checksum64(buffer, poly);      // CRC64
crc.checksumModbus(buffer);        // Modbus CRC

API 库

apilib.SleepMill(1000);           // 休眠（毫秒）
apilib.UnGzip(gzipData);           // 解压 gzip
apilib.Unzip(zipData);             // 解压 zip

日志

logger.Debug("debug message", 1);
logger.Info("info message", 2);
logger.Warn("warn message", 3);
logger.Error("error message", 4);

示例

数据处理

script := `
function handler(data) {
    return _.map(data, function(item) {
        return {
            id: item.id,
            value: item.value * 2,
            timestamp: moment().format('YYYY-MM-DD HH:mm:ss')
        };
    });
}
`

data := []map[string]interface{}{
    {"id": "1", "value": 10},
    {"id": "2", "value": 20},
}

result, err := gojs.Run(script, data)

加密解密

script := `
function handler(text) {
    var encrypted = CryptoJS.AES.encrypt(text, "secret-key").toString();
    var decrypted = CryptoJS.AES.decrypt(encrypted, "secret-key").toString(CryptoJS.enc.Utf8);
    return { encrypted: encrypted, decrypted: decrypted };
}
`

XML 转换

script := `
function handler(xmlString) {
    return xmlJs.xml2json(xmlString, { compact: true });
}
`

性能优化

脚本缓存

// 首次执行会编译并缓存
gojs.RunByIdAndScript("script-1", script, data...)

// 后续执行直接使用缓存
gojs.RunById("script-1", data...)

并发执行

var wg sync.WaitGroup
for i := 0; i < 100; i++ {
    wg.Add(1)
    go func(idx int) {
        defer wg.Done()
        result, _ := gojs.RunById("script-1", idx)
    }(i)
}
wg.Wait()

错误码

测试

# 运行所有测试
go test ./...

# 运行测试并显示覆盖率
go test -cover ./...

# 生成覆盖率报告
go test -coverprofile=coverage.out ./...
go tool cover -html=coverage.out

# 运行性能测试
go test -bench=. ./...

依赖

• goja - JavaScript 解释器
• goja_nodejs - Node.js 兼容模块
• go-cache - 内存缓存

贡献

欢迎提交 Pull Request 参与贡献！

许可证

MIT License