Java串口編程例子

時間 2021-01-05

標籤 html java git github 編程 ide 工具測試 idea 操作系統欄目 Java 简体版

原文原文鏈接

最近筆者接觸到串口編程，網上搜了些資料，順便整理一下。網上都在推薦使用Java RXTX開源類庫，它提供了Windows、Linux等不一樣操做系統下的串口和並口通訊實現，遵循GNU LGPL協議。看起來不錯，寫個例子試試。html

準備運行環境

下載RXTX

RXTX下載地址是：http://fizzed.com/oss/rxtx-for-java
筆者操做系統是Windows10，下載對應版本的壓縮包，解壓後複製RXTXcomm.jar到D:\Program Files\Java\jdk1.8.0_152\jre\lib\ext目錄下；複製rxtxParallel.dll和rxtxSerial.dll到D:\Program Files\Java\jdk1.8.0_152\jre\bin目錄下。java

注意：安裝jdk時可能也順便裝了jre，須要複製到jdk的jre目錄下。git

下載Virtual Serial Port Driver

Virtual Serial Port Driver是一款很是好用的虛擬串口模擬軟件，能夠在計算機模擬串口，方便開發和測試。安裝後打開界面以下：
github

能夠看到右側默認出現COM1和COM2的串口，點擊Add pair就能夠建立這兩個串口了，打開計算機管理，能夠看到本機多了這兩個端口，以下圖所示：
編程

建立項目

建立serialPort項目，以下圖所示：
ide

源代碼地址：https://github.com/wu-boy/serialPort.git
文中所用軟件工具等資料下載：https://download.csdn.net/download/wu_boy/14003992工具

串口工具類

如今能夠寫一個串口工具類，方便開發和測試，代碼以下：測試

public class SerialPortUtils {

    private static Logger log = LoggerFactory.getLogger(SerialPortUtils.class);

    /**
     * 打卡串口
     * @param portName 串口名
     * @param baudRate 波特率
     * @param dataBits 數據位
     * @param stopBits 中止位
     * @param parity 校驗位
     * @return 串口對象
     */
    public static SerialPort open(String portName, Integer baudRate, Integer dataBits,
                                      Integer stopBits, Integer parity) {
        SerialPort result = null;
        try {
            // 經過端口名識別端口
            CommPortIdentifier identifier = CommPortIdentifier.getPortIdentifier(portName);
            // 打開端口，並給端口名字和一個timeout（打開操做的超時時間）
            CommPort commPort = identifier.open(portName, 2000);
            // 判斷是否是串口
            if (commPort instanceof SerialPort) {
                result = (SerialPort) commPort;
                // 設置一下串口的波特率等參數
                result.setSerialPortParams(baudRate, dataBits, stopBits, parity);
                log.info("打開串口{}成功", portName);
            }else{
                log.info("{}不是串口", portName);
            }
        } catch (Exception e) {
            log.error("打開串口{}錯誤", portName, e);
        }
        return result;
    }

    /**
     * 串口增長數據可用監聽器
     * @param serialPort
     * @param listener
     */
    public static void addListener(SerialPort serialPort, DataAvailableListener listener) {
        if(serialPort == null){
            return;
        }
        try {
            // 給串口添加監聽器
            serialPort.addEventListener(new SerialPortListener(listener));
            // 設置當有數據到達時喚醒監聽接收線程
            serialPort.notifyOnDataAvailable(Boolean.TRUE);
            // 設置當通訊中斷時喚醒中斷線程
            serialPort.notifyOnBreakInterrupt(Boolean.TRUE);
        } catch (TooManyListenersException e) {
            log.error("串口{}增長數據可用監聽器錯誤", serialPort.getName(), e);
        }
    }

    /**
     * 從串口讀取數據
     * @param serialPort
     * @return
     */
    public static byte[] read(SerialPort serialPort) {
        byte[] result = {};
        if(serialPort == null){
            return result;
        }
        InputStream inputStream = null;
        try {
            inputStream = serialPort.getInputStream();

            // 緩衝區大小爲1個字節，可根據實際需求修改
            byte[] readBuffer = new byte[7];

            int bytesNum = inputStream.read(readBuffer);
            while (bytesNum > 0) {
                result = ArrayUtil.addAll(result, readBuffer);
                bytesNum = inputStream.read(readBuffer);
            }
        } catch (IOException e) {
            log.error("串口{}讀取數據錯誤", serialPort.getName(), e);
        } finally {
            IoUtil.close(inputStream);
        }
        return result;
    }

    /**
     * 往串口發送數據
     * @param serialPort
     * @param data
     */
    public static void write(SerialPort serialPort, byte[] data) {
        if(serialPort == null){
            return;
        }
        OutputStream outputStream = null;
        try {
            outputStream = serialPort.getOutputStream();
            outputStream.write(data);
            outputStream.flush();
        } catch (Exception e) {
            log.error("串口{}發送數據錯誤", serialPort.getName(), e);
        } finally {
            IoUtil.close(outputStream);
        }
    }

    /**
     * 關閉串口
     * @param serialPort
     */
    public static void close(SerialPort serialPort) {
        if (serialPort != null) {
            serialPort.close();
            log.warn("串口{}關閉", serialPort.getName());
        }
    }

    /**
     * 查詢可用端口
     * @return 串口名List
     */
    public static List<String> listPortName() {
        List<String> result = new ArrayList<>();

        // 得到當前全部可用端口
        Enumeration<CommPortIdentifier> serialPorts = CommPortIdentifier.getPortIdentifiers();
        if(serialPorts == null){
            return result;
        }

        // 將可用端口名添加到List並返回該List
        while (serialPorts.hasMoreElements()) {
            result.add(serialPorts.nextElement().getName());
        }
        return result;
    }
}

測試代碼

測試代碼以下，先不要着急運行，下一步打開串口調試助手協助測試。idea

public class SerialPortTest {

    public static void main(String[] args) throws Exception{

        // 打開串口
        SerialPort serialPort = SerialPortUtils.open("COM1", 9600, SerialPort.DATABITS_8,
                SerialPort.STOPBITS_1, SerialPort.PARITY_NONE);

        // 監聽串口讀取數據
        SerialPortUtils.addListener(serialPort, () -> {
            byte[] data = SerialPortUtils.read(serialPort);
            System.out.println(HexUtil.encodeHexStr(data));
        });

        // 往串口發送數據
        byte[] data = {1, 2, 3};
        SerialPortUtils.write(serialPort, data);

        /*// 關閉串口
        Thread.sleep(2000);
        SerialPortUtils.close(serialPort);*/

        // 測試可用端口
        //SerialPortUtils.listPortName().forEach(o -> System.out.println(o));
    }
}