一个自用的二进制通讯消息协议 - 三生万物

格式

[7f] [命令（1byte）] [子命令（2byte）] [dataLength（2byte，范围：data + CRC + end）] [data] [crc（2byte）][7e]

编码

BinaryMessage

Scala

package com.xxx.play.base.controller

import java.util

import com.xxx.play.base.util.{CRC16, HexadecimalUtil}

/**
 * 二进制消息
 *
 * 格式：[7f] [命令（1byte）] [子命令（2byte）] [dataLength（2byte，范围：data）] [data] [crc（2byte）][7e]
 *
 * 大小端：网络传输通用模式（大端模式）
 *
 * @author Rubin
 * @version v1 2020/12/16 17:24
 */
case class BinaryMessage(command: Int, subcommand: Int, data: Array[Byte] = Array.emptyByteArray) {

  def getLength: Array[Byte] = {
    HexadecimalUtil.toByteArray(HexadecimalUtil.get16NumAdd0(data.length + 3, 4))
  }

  def getCrc: Array[Byte] = {
    HexadecimalUtil.toByteArray(HexadecimalUtil.get16NumAdd0(CRC16.crc16(data), 4))
  }

  def toArray: Array[Byte] = BinaryMessage.toArray(this)

}

object BinaryMessage {

  val HEAD = 0x7f
  val END = 0x7e
  val DEFAULT_LENGTH = 9 // HEAD + Command + Subcommand +length + CRC + END

  private var head = 0
  private var buffer = new Array[Byte](1024)
  private var index = -1
  private var dataLen = 0

  /**
   * 转BinaryMessage
   *
   * @param bytes 字节数组
   * @return BinaryMessage
   */
  def toMessage(bytes: Array[Byte]): BinaryMessage = {
    assert(bytes.head == HEAD && bytes.last == END)

    val command = bytes(1).asInstanceOf[Int]
    val subcommand = HexadecimalUtil.get10HexBytes(Array(bytes(2), bytes(3)))
    val data = util.Arrays.copyOfRange(bytes, 6, bytes.length - 3)

    BinaryMessage(command, subcommand, data)
  }

  /**
   * 转字节数组
   *
   * @param message BinaryMessage
   * @return 字节数组
   */
  def toArray(message: BinaryMessage): Array[Byte] = {

    val dataLen = message.data.length
    val binaryArray = new Array[Byte](DEFAULT_LENGTH + dataLen)
    val subcommand = HexadecimalUtil.toByteArray(HexadecimalUtil.get16NumAdd0(message.subcommand, 4))
    val length = message.getLength
    val crc = message.getCrc

    System.arraycopy(message.data, 0, binaryArray, 6, dataLen)

    binaryArray(0) = HEAD.toByte
    binaryArray(1) = message.command.toByte
    binaryArray(2) = subcommand(0)
    binaryArray(3) = subcommand(1)
    binaryArray(4) = length(0)
    binaryArray(5) = length(1)
    binaryArray(6 + dataLen) = crc(0)
    binaryArray(7 + dataLen) = crc(1)
    binaryArray(8 + dataLen) = END.toByte

    binaryArray
  }

  /**
   * 分帧
   *
   * @param data  原始数据
   * @param frame 分帧数据
   */
  def decoder(data: Array[Byte], frame: Array[Byte] => Unit): Unit = {
    for (byte <- data) {
      if (head == 1) {
        buffer({
          index += 1
          index
        }) = byte
        if (index == 5) dataLen = HexadecimalUtil.get10HexBytes(Array[Byte](buffer(4), buffer(5)))
        else if (dataLen == (index - 5)) {
          frame(util.Arrays.copyOfRange(buffer, 0, dataLen + 5))
          // 重新读取，初始化下标
          head = 0
          index = -1
          dataLen = 0
          buffer = new Array[Byte](1024)
        }
      }
      else if (byte == 127) {
        buffer({
          index += 1
          index
        }) = byte
        head = 1
      }
    }

  }

  //    def main(args: Array[String]): Unit = {
  //      val message = BinaryMessage(1, 127, "123456789".getBytes())
  //      val array = message.toArray
  //      println(HexadecimalUtil.bytes2HexString(array))
  //
  //      val message1 = BinaryMessage.toMessage(array)
  //
  //      println(HexadecimalUtil.bytes2HexString(message1.toArray))
  //    }

  // 7F01007F000C313233343536373839BB3D7E
}

CRC16

package com.xxx.play.base.util;

public class CRC16 {

    public static int crc16(byte[] bytes) {

        int[] table = {
                0x0000, 0xC0C1, 0xC181, 0x0140, 0xC301, 0x03C0, 0x0280, 0xC241,
                0xC601, 0x06C0, 0x0780, 0xC741, 0x0500, 0xC5C1, 0xC481, 0x0440,
                0xCC01, 0x0CC0, 0x0D80, 0xCD41, 0x0F00, 0xCFC1, 0xCE81, 0x0E40,
                0x0A00, 0xCAC1, 0xCB81, 0x0B40, 0xC901, 0x09C0, 0x0880, 0xC841,
                0xD801, 0x18C0, 0x1980, 0xD941, 0x1B00, 0xDBC1, 0xDA81, 0x1A40,
                0x1E00, 0xDEC1, 0xDF81, 0x1F40, 0xDD01, 0x1DC0, 0x1C80, 0xDC41,
                0x1400, 0xD4C1, 0xD581, 0x1540, 0xD701, 0x17C0, 0x1680, 0xD641,
                0xD201, 0x12C0, 0x1380, 0xD341, 0x1100, 0xD1C1, 0xD081, 0x1040,
                0xF001, 0x30C0, 0x3180, 0xF141, 0x3300, 0xF3C1, 0xF281, 0x3240,
                0x3600, 0xF6C1, 0xF781, 0x3740, 0xF501, 0x35C0, 0x3480, 0xF441,
                0x3C00, 0xFCC1, 0xFD81, 0x3D40, 0xFF01, 0x3FC0, 0x3E80, 0xFE41,
                0xFA01, 0x3AC0, 0x3B80, 0xFB41, 0x3900, 0xF9C1, 0xF881, 0x3840,
                0x2800, 0xE8C1, 0xE981, 0x2940, 0xEB01, 0x2BC0, 0x2A80, 0xEA41,
                0xEE01, 0x2EC0, 0x2F80, 0xEF41, 0x2D00, 0xEDC1, 0xEC81, 0x2C40,
                0xE401, 0x24C0, 0x2580, 0xE541, 0x2700, 0xE7C1, 0xE681, 0x2640,
                0x2200, 0xE2C1, 0xE381, 0x2340, 0xE101, 0x21C0, 0x2080, 0xE041,
                0xA001, 0x60C0, 0x6180, 0xA141, 0x6300, 0xA3C1, 0xA281, 0x6240,
                0x6600, 0xA6C1, 0xA781, 0x6740, 0xA501, 0x65C0, 0x6480, 0xA441,
                0x6C00, 0xACC1, 0xAD81, 0x6D40, 0xAF01, 0x6FC0, 0x6E80, 0xAE41,
                0xAA01, 0x6AC0, 0x6B80, 0xAB41, 0x6900, 0xA9C1, 0xA881, 0x6840,
                0x7800, 0xB8C1, 0xB981, 0x7940, 0xBB01, 0x7BC0, 0x7A80, 0xBA41,
                0xBE01, 0x7EC0, 0x7F80, 0xBF41, 0x7D00, 0xBDC1, 0xBC81, 0x7C40,
                0xB401, 0x74C0, 0x7580, 0xB541, 0x7700, 0xB7C1, 0xB681, 0x7640,
                0x7200, 0xB2C1, 0xB381, 0x7340, 0xB101, 0x71C0, 0x7080, 0xB041,
                0x5000, 0x90C1, 0x9181, 0x5140, 0x9301, 0x53C0, 0x5280, 0x9241,
                0x9601, 0x56C0, 0x5780, 0x9741, 0x5500, 0x95C1, 0x9481, 0x5440,
                0x9C01, 0x5CC0, 0x5D80, 0x9D41, 0x5F00, 0x9FC1, 0x9E81, 0x5E40,
                0x5A00, 0x9AC1, 0x9B81, 0x5B40, 0x9901, 0x59C0, 0x5880, 0x9841,
                0x8801, 0x48C0, 0x4980, 0x8941, 0x4B00, 0x8BC1, 0x8A81, 0x4A40,
                0x4E00, 0x8EC1, 0x8F81, 0x4F40, 0x8D01, 0x4DC0, 0x4C80, 0x8C41,
                0x4400, 0x84C1, 0x8581, 0x4540, 0x8701, 0x47C0, 0x4680, 0x8641,
                0x8201, 0x42C0, 0x4380, 0x8341, 0x4100, 0x81C1, 0x8081, 0x4040,
        };

        int crc = 0x0000;
        for (byte b : bytes) {
            crc = (crc >>> 8) ^ table[(crc ^ b) & 0xff];
        }

        return crc;
    }

}

Js

import {dec2hex, hexStr2Bytes} from './hexUtil'
import {crc16_int} from './crc16_ibm'

const HEAD = 0x7f
const END = 0x7e
// HEAD + Command + Subcommand +length + CRC + END
// const DEFAULT_LENGTH = 9

export function BinaryMessage(command, subcommand, data) {
    if (typeof data == 'string') {
        this.data = hexStr2Bytes(data)
    } else {
        this.data = data
    }
    this.command = command
    this.subcommand = subcommand
    this.toBinaryArray = toBinaryArray(this)
}

function toBinaryArray(message) {

    const data = message.data
    const dataLen = data.length
    const command = message.command
    const subcommand = getSubcommandBytes(message.subcommand)
    const length = getLength(dataLen)
    const crc = crc16(data)

    let bytes = []
    bytes[0] = HEAD
    bytes[1] = command
    bytes[2] = subcommand[0]
    bytes[3] = subcommand[1]
    bytes[4] = length[0]
    bytes[5] = length[1]
    bytes[6 + dataLen] = crc[0]
    bytes[7 + dataLen] = crc[1]
    bytes[8 + dataLen] = END

    // add data
    for (let i = 0; i < dataLen; i++) {
        bytes[6 + i] = data[i]
    }

    return bytes
}

function getSubcommandBytes(subcommand) {
    return hexStr2Bytes(dec2hex(subcommand, 4))
}

function getLength(dataLen) {
    return hexStr2Bytes(dec2hex(dataLen + 3, 4))
}

function crc16(data) {
    return hexStr2Bytes(dec2hex(crc16_int(data), 4))
}

解码

参考 Netty：一个分帧解码程序

前端CRC校验

function crc16_ibm(cData_str) {
    const cData = hexStr2Bytes(cData_str);
    let crc = CRC16_IBM(cData);
    // let crcLen = crc.length;
    // crc = crcLen >= 4 ? crc.slice(2, 4) + crc.slice(0, 2) : crcLen === 3 ? crc.slice(1, 3) + '0' + crc.slice(0, 1) : crcLen === 2 ? crc + '00' : '0' + crc + '00';
    return crc;
}

function hexStr2Bytes(str) {
    let pos = 0;
    let len = str.length;
    if (len % 2 !== 0) {
        return null;
    }
    len /= 2;
    const arrBytes = [];
    for (let i = 0; i < len; i++) {
        const s = str.substr(pos, 2);
        const v = parseInt(s, 16);
        arrBytes.push(v);
        pos += 2;
    }
    return arrBytes;
}

function CRC16_IBM(cData) {
    let cLen = cData.length;
    let CRC16Table = [
        0x0000, 0xC0C1, 0xC181, 0x0140, 0xC301, 0x03C0, 0x0280, 0xC241,
        0xC601, 0x06C0, 0x0780, 0xC741, 0x0500, 0xC5C1, 0xC481, 0x0440,
        0xCC01, 0x0CC0, 0x0D80, 0xCD41, 0x0F00, 0xCFC1, 0xCE81, 0x0E40,
        0x0A00, 0xCAC1, 0xCB81, 0x0B40, 0xC901, 0x09C0, 0x0880, 0xC841,
        0xD801, 0x18C0, 0x1980, 0xD941, 0x1B00, 0xDBC1, 0xDA81, 0x1A40,
        0x1E00, 0xDEC1, 0xDF81, 0x1F40, 0xDD01, 0x1DC0, 0x1C80, 0xDC41,
        0x1400, 0xD4C1, 0xD581, 0x1540, 0xD701, 0x17C0, 0x1680, 0xD641,
        0xD201, 0x12C0, 0x1380, 0xD341, 0x1100, 0xD1C1, 0xD081, 0x1040,
        0xF001, 0x30C0, 0x3180, 0xF141, 0x3300, 0xF3C1, 0xF281, 0x3240,
        0x3600, 0xF6C1, 0xF781, 0x3740, 0xF501, 0x35C0, 0x3480, 0xF441,
        0x3C00, 0xFCC1, 0xFD81, 0x3D40, 0xFF01, 0x3FC0, 0x3E80, 0xFE41,
        0xFA01, 0x3AC0, 0x3B80, 0xFB41, 0x3900, 0xF9C1, 0xF881, 0x3840,
        0x2800, 0xE8C1, 0xE981, 0x2940, 0xEB01, 0x2BC0, 0x2A80, 0xEA41,
        0xEE01, 0x2EC0, 0x2F80, 0xEF41, 0x2D00, 0xEDC1, 0xEC81, 0x2C40,
        0xE401, 0x24C0, 0x2580, 0xE541, 0x2700, 0xE7C1, 0xE681, 0x2640,
        0x2200, 0xE2C1, 0xE381, 0x2340, 0xE101, 0x21C0, 0x2080, 0xE041,
        0xA001, 0x60C0, 0x6180, 0xA141, 0x6300, 0xA3C1, 0xA281, 0x6240,
        0x6600, 0xA6C1, 0xA781, 0x6740, 0xA501, 0x65C0, 0x6480, 0xA441,
        0x6C00, 0xACC1, 0xAD81, 0x6D40, 0xAF01, 0x6FC0, 0x6E80, 0xAE41,
        0xAA01, 0x6AC0, 0x6B80, 0xAB41, 0x6900, 0xA9C1, 0xA881, 0x6840,
        0x7800, 0xB8C1, 0xB981, 0x7940, 0xBB01, 0x7BC0, 0x7A80, 0xBA41,
        0xBE01, 0x7EC0, 0x7F80, 0xBF41, 0x7D00, 0xBDC1, 0xBC81, 0x7C40,
        0xB401, 0x74C0, 0x7580, 0xB541, 0x7700, 0xB7C1, 0xB681, 0x7640,
        0x7200, 0xB2C1, 0xB381, 0x7340, 0xB101, 0x71C0, 0x7080, 0xB041,
        0x5000, 0x90C1, 0x9181, 0x5140, 0x9301, 0x53C0, 0x5280, 0x9241,
        0x9601, 0x56C0, 0x5780, 0x9741, 0x5500, 0x95C1, 0x9481, 0x5440,
        0x9C01, 0x5CC0, 0x5D80, 0x9D41, 0x5F00, 0x9FC1, 0x9E81, 0x5E40,
        0x5A00, 0x9AC1, 0x9B81, 0x5B40, 0x9901, 0x59C0, 0x5880, 0x9841,
        0x8801, 0x48C0, 0x4980, 0x8941, 0x4B00, 0x8BC1, 0x8A81, 0x4A40,
        0x4E00, 0x8EC1, 0x8F81, 0x4F40, 0x8D01, 0x4DC0, 0x4C80, 0x8C41,
        0x4400, 0x84C1, 0x8581, 0x4540, 0x8701, 0x47C0, 0x4680, 0x8641,
        0x8201, 0x42C0, 0x4380, 0x8341, 0x4100, 0x81C1, 0x8081, 0x4040
    ];

    let result = 0;
    let tableNo = 0;

    for (let i = 0; i < cLen; i++) {
        tableNo = ((result & 0xff) ^ (cData[i] & 0xff));
        result = ((result >> 8) & 0xff) ^ CRC16Table[tableNo];
    }
    return result.toString(16).toUpperCase();
}

module.exports = {crc16_ibm}

Test

scala

def main(args: Array[String]): Unit = {
  val message = BinaryMessage(1, 127, "123456789".getBytes())
  println(HexadecimalUtil.bytes2HexString(message.toBinaryArray))
}

在这里插入图片描述

vue

created() {
  const msg = new BinaryMessage(1, 127, '313233343536373839')
  const message = msg.toBinaryArray;
  console.log(bytes2HexString(message))
}

在这里插入图片描述

计算机基础编码

网络通讯 js 协议编码 crc

本博客所有文章除特别声明外，均采用 CC BY-SA 4.0 协议，转载请注明出处！

HTML：5种回到顶部的写法从实现到增强上一篇

统计学两天课程笔记（12.19-12.20）下一篇