Rust CoAP协议库coap-message使用指南

介绍

coap-message是一个轻量级的Rust库，用于处理CoAP(Constrained Application Protocol)协议消息。CoAP是专为物联网(IoT)设计的应用层协议，特别适合资源受限的设备通信。

该库提供了构建、解析和处理CoAP消息的核心功能，支持RFC7252定义的CoAP协议规范，具有以下特点：

• 零拷贝设计，高效处理消息
• 支持CoAP消息的编码与解码
• 提供选项(Options)处理功能
• 轻量级实现，适合嵌入式环境

安装

在Cargo.toml中添加依赖：

[dependencies]
coap-message = "0.2"

基本使用方法

创建CoAP请求消息

use coap_message::{MutableWritableMessage, ReadableMessage};
use coap_message_0_2::{MessageType, MessageClass};

fn create_get_request() -> Vec<u8> {
    let mut buf = vec![0; 64];
    let mut message = coap_message_0_2::MutableMessage::new(&mut buf);
    
    message.set_type(MessageType::Confirmable);
    message.set_code(MessageClass::Request(1)); // GET请求
    message.set_message_id(1234);
    message.add_option(coap_message_0_2::OptionNumber::UriPath, b"temperature");
    
    message.payload().extend_from_slice(b"");
    
    message.finish().unwrap().to_vec()
}

解析CoAP响应

use coap_message::ReadableMessage;

fn parse_response(data: &[u8]) {
    let message = coap_message_0_2::ReadableMessage::new(data).unwrap();
    
    println!("Message type: {:?}", message.get_type());
    println!("Status code: {:?}", message.get_code());
    println!("Message ID: {}", message.get_message_id());
    
    for option in message.options() {
        println!("Option {:?}: {:?}", option.number(), option.value());
    }
    
    if let Some(payload) = message.payload() {
        println!("Payload: {:?}", payload);
    }
}

高级功能

处理CoAP选项

fn handle_options(message: &impl ReadableMessage) {
    // 获取所有Uri-Path选项
    let paths: Vec<&[u8]> = message.get_options(coap_message_0_2::OptionNumber::UriPath)
        .collect();
    
    // 获取Content-Format选项
    if let Some(format) = message.get_first_option(coap_message_0_2::OptionNumber::ContentFormat) {
        println!("Content format: {:?}", format);
    }
}

构建带观察选项的请求

fn create_observe_request() -> Vec<u8> {
    let mut buf = vec![0; 128];
    let mut message = coap_message_0_2::MutableMessage::new(&mut buf);
    
    message.set_type(MessageType::Confirmable);
    message.set_code(MessageClass::Request(1)); // GET请求
    message.set_message_id(5678);
    message.add_option(coap_message_0_2::OptionNumber::UriPath, b"sensor");
    message.add_option(coap_message_0_2::OptionNumber::Observe, &[0]); // 注册观察
    
    message.finish().unwrap().to_vec()
}

完整示例代码

use std::net::UdpSocket;
use coap_message::{MutableWritableMessage, ReadableMessage};
use coap_message_0_2::{MessageType, MessageClass, OptionNumber};

fn main() -> std::io::Result<()> {
    // 创建UDP socket
    let socket = UdpSocket::bind("0.0.0.0:5683")?;
    println!("CoAP server listening on 0.0.0.0:5683");

    let mut buf = [0; 1024];
    
    loop {
        // 接收请求
        let (len, addr) = socket.recv_from(&mut buf)?;
        println!("Received request from {}", addr);
        
        // 解析请求
        let request = match coap_message_0_2::ReadableMessage::new(&buf[..len]) {
            Ok(msg) => msg,
            Err(e) => {
                eprintln!("Failed to parse CoAP message: {}", e);
                continue;
            }
        };
        
        // 打印请求信息
        println!("Message type: {:?}", request.get_type());
        println!("Code: {:?}", request.get_code());
        
        // 处理Uri-Path选项
        let paths: Vec<&[u8]> = request.get_options(OptionNumber::UriPath).collect();
        println!("Uri-Path: {:?}", paths);
        
        // 准备响应缓冲区
        let mut response_buf = [0; 1024];
        let mut response = coap_message_0_2::MutableMessage::new(&mut response_buf);
        
        // 设置响应参数
        response.set_type(MessageType::Acknowledgement);
        response.set_code(MessageClass::Response(2.05)); // 2.05 Content
        response.set_message_id(request.get_message_id());
        
        // 添加Content-Format选项
        response.add_option(OptionNumber::ContentFormat, &[0x28]); // text/plain
        
        // 设置响应payload
        let payload = b"Hello from CoAP server!";
        response.payload().extend_from_slice(payload);
        
        // 完成消息构建
        let response_data = response.finish().unwrap().to_vec();
        
        // 发送响应
        socket.send_to(&response_data, addr)?;
        println!("Sent response to {}", addr);
    }
}

注意事项

1. coap-message只处理消息格式，不包含网络传输功能，需要配合UDP或其他传输层使用
2. 对于更完整的CoAP实现，可以考虑基于此库构建或使用更高级的库如coap-lite
3. 在嵌入式环境中使用时，注意内存分配问题，可以使用静态缓冲区

这个库非常适合需要轻量级CoAP实现或需要自定义CoAP处理的场景，特别是在资源受限的物联网设备上。