java讀寫串口數據

本博文參考自https://www.cnblogs.com/Dreamer-1/p/5523046.html

 

沒想到挺多人需要這個的，很高興這篇文章能對大家有幫助，主要的工具類博文里已經有了，當然，要小工具源碼的留言郵箱即可。   2019.09.05

 

最近接觸到了串口及其讀寫，在此記錄java進行串口讀寫的過程。

1.導入支持java串口通信的jar包：

在maven項目的pom.xml中添加RXTXcomm的依賴 或者 下載RXTXcomm.jar並導入到項目中。

支持Java串口通信操作的jar包，java.comm比較老，而且不支持64位系統，推薦使用Rxtx這個jar包（32位/64位均支持）。

下載地址：

http://files.cnblogs.com/files/Dreamer-1/mfz-rxtx-2.2-20081207-win-x86.zip （32位）

http://files.cnblogs.com/files/Dreamer-1/mfz-rxtx-2.2-20081207-win-x64.zip （64位）

 

注意：運行過程中拋出 java.lang.UnsatisfiedLinkError 錯誤或 gnu.io 下的類找不到時，將rxtx解壓包中的 rxtxParallel.dll，rxtxSerial.dll 這兩個文件復制到 C:\Windows\System32 目錄下可解決該錯誤。

2.編寫代碼操作串口：

串口必要參數類：包含連接串口所必須的參數，方便在調用串口時設置和傳遞串口參數

/**
 * 串口必要參數接收類
 * @author: LinWenLi
 * @date: 2018年7月21日 下午4:30:40
 */
public class ParamConfig {

    private String serialNumber;// 串口號
    private int baudRate;        // 波特率
    private int checkoutBit;    // 校驗位
    private int dataBit;        // 數據位
    private int stopBit;        // 停止位
    
    public ParamConfig() {} /** * 構造方法 * @param serialNumber 串口號 * @param baudRate 波特率 * @param checkoutBit 校驗位 * @param dataBit 數據位 * @param stopBit 停止位 */ public ParamConfig(String serialNumber, int baudRate, int checkoutBit, int dataBit, int stopBit) { this.serialNumber = serialNumber; this.baudRate = baudRate; this.checkoutBit = checkoutBit; this.dataBit = dataBit; this.stopBit = stopBit; }
 getter()... setter()... }

串口操作類：（其中包含的CustomException是自定義異常類，僅用於拋出異常原因。）

import gnu.io.CommPortIdentifier;
import gnu.io.PortInUseException;
import gnu.io.SerialPort;
import gnu.io.SerialPortEvent;
import gnu.io.SerialPortEventListener;
import gnu.io.UnsupportedCommOperationException;

/**
 * 串口參數的配置 串口一般有如下參數可以在該串口打開以前進行配置： 包括串口號，波特率，輸入/輸出流控制，數據位數，停止位和奇偶校驗。
 */
// 注：串口操作類一定要繼承SerialPortEventListener
public class SerialPortUtils implements SerialPortEventListener {
    // 檢測系統中可用的通訊端口類
    private CommPortIdentifier commPortId;
    // 枚舉類型
    private Enumeration<CommPortIdentifier> portList;
    // RS232串口
    private SerialPort serialPort;
    // 輸入流
    private InputStream inputStream;
    // 輸出流
    private OutputStream outputStream;
    // 保存串口返回信息
    private String data;
    // 保存串口返回信息十六進制
    private String dataHex;/**
     * 初始化串口
     * @author LinWenLi
     * @date 2018年7月21日下午3:44:16
     * @Description: TODO
     * @param: paramConfig  存放串口連接必要參數的對象（會在下方給出類代碼）    
     * @return: void      
     * @throws
     */
    @SuppressWarnings("unchecked")
    public void init(ParamConfig paramConfig) {
        // 獲取系統中所有的通訊端口
        portList = CommPortIdentifier.getPortIdentifiers();
        // 記錄是否含有指定串口
        boolean isExsist = false;
        // 循環通訊端口
        while (portList.hasMoreElements()) {
            commPortId = portList.nextElement();
            // 判斷是否是串口
            if (commPortId.getPortType() == CommPortIdentifier.PORT_SERIAL) {
                // 比較串口名稱是否是指定串口
                if (paramConfig.getSerialNumber().equals(commPortId.getName())) {
                    // 串口存在
                    isExsist = true;
                    // 打開串口
                    try {
                        // open:（應用程序名【隨意命名】，阻塞時等待的毫秒數）
                        serialPort = (SerialPort) commPortId.open(Object.class.getSimpleName(), 2000);
                        // 設置串口監聽
                        serialPort.addEventListener(this);
                        // 設置串口數據時間有效(可監聽)
                        serialPort.notifyOnDataAvailable(true);
                        // 設置串口通訊參數:波特率，數據位，停止位,校驗方式
                        serialPort.setSerialPortParams(paramConfig.getBaudRate(), paramConfig.getDataBit(),
                                paramConfig.getStopBit(), paramConfig.getCheckoutBit());
                    } catch (PortInUseException e) {
                        throw new CustomException("端口被占用");
                    } catch (TooManyListenersException e) {
                        throw new CustomException("監聽器過多");
                    } catch (UnsupportedCommOperationException e) {
                        throw new CustomException("不支持的COMM端口操作異常");
                    }
                    // 結束循環
                    break;
                }
            }
        }
        // 若不存在該串口則拋出異常
        if (!isExsist) {
            throw new CustomException("不存在該串口！");
        }
    }

    /**
     * 實現接口SerialPortEventListener中的方法 讀取從串口中接收的數據
     */
    @Override
    public void serialEvent(SerialPortEvent event) {
        switch (event.getEventType()) {
        case SerialPortEvent.BI: // 通訊中斷
        case SerialPortEvent.OE: // 溢位錯誤
        case SerialPortEvent.FE: // 幀錯誤
        case SerialPortEvent.PE: // 奇偶校驗錯誤
        case SerialPortEvent.CD: // 載波檢測
        case SerialPortEvent.CTS: // 清除發送
        case SerialPortEvent.DSR: // 數據設備准備好
        case SerialPortEvent.RI: // 響鈴偵測
        case SerialPortEvent.OUTPUT_BUFFER_EMPTY: // 輸出緩沖區已清空
            break;
        case SerialPortEvent.DATA_AVAILABLE: // 有數據到達
            // 調用讀取數據的方法
            readComm();
            break;
        default:
            break;
        }
    }

    /**
     * 讀取串口返回信息
     * @author LinWenLi
     * @date 2018年7月21日下午3:43:04
     * @return: void      
     */
    public void readComm() {
        try {
            inputStream = serialPort.getInputStream();
            // 通過輸入流對象的available方法獲取數組字節長度
            byte[] readBuffer = new byte[inputStream.available()];
            // 從線路上讀取數據流
            int len = 0;
            while ((len = inputStream.read(readBuffer)) != -1) {
　　　　　　　　　// 直接獲取到的數據
                data = new String(readBuffer, 0, len).trim();
　　　　　　　　　// 轉為十六進制數據
                dataHex = bytesToHexString(readBuffer);
                System.out.println("data:" + data);
                System.out.println("dataHex:" + dataHex);// 讀取后置空流對象
                inputStream.close();
                inputStream = null;
                break;
            }
        } catch (IOException e) {
            throw new CustomException("讀取串口數據時發生IO異常");
        }
    }

    /**
     * 發送信息到串口
     * @author LinWenLi
     * @date 2018年7月21日下午3:45:22
     * @param: data      
     * @return: void      
     * @throws
     */
    public void sendComm(String data) {
        byte[] writerBuffer = null;
        try {
            writerBuffer = hexToByteArray(data);
        } catch (NumberFormatException e) {
            throw new CustomException("命令格式錯誤！");
        }
        try {
            outputStream = serialPort.getOutputStream();
            outputStream.write(writerBuffer);
            outputStream.flush();
        } catch (NullPointerException e) {
            throw new CustomException("找不到串口。");
        } catch (IOException e) {
            throw new CustomException("發送信息到串口時發生IO異常");
        }
    }

    /**
     * 關閉串口
     * @author LinWenLi
     * @date 2018年7月21日下午3:45:43
     * @Description: 關閉串口
     * @param:       
     * @return: void      
     * @throws
     */
    public void closeSerialPort() {
        if (serialPort != null) {
            serialPort.notifyOnDataAvailable(false);
            serialPort.removeEventListener();
            if (inputStream != null) {
                try {
                    inputStream.close();
                    inputStream = null;
                } catch (IOException e) {
                    throw new CustomException("關閉輸入流時發生IO異常");
                }
            }
            if (outputStream != null) {
                try {
                    outputStream.close();
                    outputStream = null;
                } catch (IOException e) {
                    throw new CustomException("關閉輸出流時發生IO異常");
                }
            }
            serialPort.close();
            serialPort = null;
        }
    }

    /**
     * 十六進制串口返回值獲取
     */
    public String getDataHex() {
        String result = dataHex;
        // 置空執行結果
        dataHex = null;
        // 返回執行結果
        return result;
    }

    /**
     * 串口返回值獲取
     */
    public String getData() {
        String result = data;
        // 置空執行結果
        data = null;
        // 返回執行結果
        return result;
    }

    /**
     * Hex字符串轉byte
     * @param inHex 待轉換的Hex字符串
     * @return 轉換后的byte
     */
    public static byte hexToByte(String inHex) {
        return (byte) Integer.parseInt(inHex, 16);
    }

    /**
     * hex字符串轉byte數組
     * @param inHex 待轉換的Hex字符串
     * @return 轉換后的byte數組結果
     */
    public static byte[] hexToByteArray(String inHex) {
        int hexlen = inHex.length();
        byte[] result;
        if (hexlen % 2 == 1) {
            // 奇數
            hexlen++;
            result = new byte[(hexlen / 2)];
            inHex = "0" + inHex;
        } else {
            // 偶數
            result = new byte[(hexlen / 2)];
        }
        int j = 0;
        for (int i = 0; i < hexlen; i += 2) {
            result[j] = hexToByte(inHex.substring(i, i + 2));
            j++;
        }
        return result;
    }

    /**
     * 數組轉換成十六進制字符串
     * @param byte[]
     * @return HexString
     */
    public static final String bytesToHexString(byte[] bArray) {
        StringBuffer sb = new StringBuffer(bArray.length);
        String sTemp;
        for (int i = 0; i < bArray.length; i++) {
            sTemp = Integer.toHexString(0xFF & bArray[i]);
            if (sTemp.length() < 2)
                sb.append(0);
            sb.append(sTemp.toUpperCase());
        }
        return sb.toString();
    }
}

調用串口操作類的代碼：

     public static void main(String[] args) {
         // 實例化串口操作類對象
         SerialPortUtils serialPort = new SerialPortUtils();
         // 創建串口必要參數接收類並賦值，賦值串口號，波特率，校驗位，數據位，停止位
         ParamConfig paramConfig = new ParamConfig("COM4", 9600, 0, 8, 1);
         // 初始化設置,打開串口，開始監聽讀取串口數據
         serialPort.init(paramConfig);
         // 調用串口操作類的sendComm方法發送數據到串口
         serialPort.sendComm("FEF10A000000000000000AFF");
         // 關閉串口
         serialPort.closeSerialPort();
     }

當執行main方法中的代碼且未執行關閉串口時，程序將一直處於開啟狀態，自動監聽，接收讀取來自串口的數據。

注意：一個串口只能打開一次，並只支持一個程序調用。

 以上所記錄的是簡單測試java是否能成功操作串口數據，至於本人所寫的Web端的讀卡器調試功能則是在串口操作類的基礎上編寫網頁界面，通過請求來控制串口的開啟關閉及相應的設置，功能比較簡單，放個界面記錄一下：