SpringBoot生成條形碼的方案詳解

更新時間：2024年08月13日 08:53:43 作者：碼到三十五

在Spring Boot, Spring Cloud 項目中整合ZXing庫來生成條形碼在特定行業(yè)也是一個常見需求,ZXing是google開源的一個功能強大的Java庫,專門用于二維碼/條形碼等的生成與解析,所以本文給大家介紹了SpringBoot生成條形碼的方案,需要的朋友可以參考下

引言

在Spring Boot, Spring Cloud 項目中整合ZXing庫來生成條形碼在特定行業(yè)也是一個常見需求。

ZXing是google開源的一個功能強大的Java庫，專門用于二維碼/條形碼等的生成與解析。它不僅能夠生成QR碼/條形碼，還能解析包括QR碼/條形碼在內的多種格式.

1. 添加zxing的依賴

<dependency>
    <groupId>com.google.zxing</groupId>
    <artifactId>core</artifactId>
    <version>3.5.2</version>
</dependency>
<dependency>
    <groupId>com.google.zxing</groupId>
    <artifactId>javase</artifactId>
    <version>3.5.2</version>
</dependency>

2. 生成條形碼

import com.google.zxing.BarcodeFormat;
import com.google.zxing.WriterException;
import com.google.zxing.client.j2se.MatrixToImageWriter;
import com.google.zxing.common.BitMatrix;
import com.google.zxing.oned.Code128Writer;
import org.springframework.stereotype.Service;

import java.io.IOException;
import java.nio.file.FileSystems;
import java.nio.file.Path;

@Service
public class BarcodeService {

    /**
     * 生成條形碼并保存到指定路徑
     * @param content 條形碼內容
     * @param path 保存路徑
     * @param width 條形碼寬度
     * @param height 條形碼高度
     */
    public void generateBarcodeImage(String content, String path, int width, int height) {
        Code128Writer barcodeWriter = new Code128Writer();
        BitMatrix bitMatrix = null;
        try {
            bitMatrix = barcodeWriter.encode(content, BarcodeFormat.CODE_128, width, height);
            Path filePath = FileSystems.getDefault().getPath(path);
            MatrixToImageWriter.writeToPath(bitMatrix, "PNG", filePath);
        } catch (WriterException | IOException e) {
            e.printStackTrace();
        }
    }
}

3. 調用條形碼服務

最后，在Spring Boot的中調用這個服務生成條形碼：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class BarcodeController {

    @Autowired
    private BarcodeService barcodeService;

    @GetMapping("/generate-barcode")
    public String generateBarcode(@RequestParam String content, @RequestParam String path, @RequestParam int width, @RequestParam int height) {
        barcodeService.generateBarcodeImage(content, path, width, height);
        return "Barcode generated successfully at " + path;
    }
}

現在，當你訪問/generate-barcode端點并傳遞相應的參數時，它將生成一個條形碼并將其保存到指定的路徑。例如：

http://localhost:8080/generate-barcode?content=123456789&path=/path/to/barcode.png&width=300&height=100

這將生成一個內容為123456789、寬度為300像素、高度為100像素的條形碼，并將其保存到/path/to/barcode.png路徑下。

4. 返回條形碼

如果需要將條形碼直接返回,簡單修改一下就好。

先修改BarcodeService以返回一個byte[]數組：

import com.google.zxing.*;
import com.google.zxing.client.j2se.MatrixToImageConfig;
import com.google.zxing.client.j2se.MatrixToImageWriter;
import com.google.zxing.common.BitMatrix;
import com.google.zxing.oned.Code128Writer;
import org.springframework.stereotype.Service;

import java.io.ByteArrayOutputStream;
import java.io.IOException;

@Service
public class BarcodeService {

    /**
     * 生成條形碼的字節(jié)數據
     * @param content 條形碼內容
     * @param width 條形碼寬度
     * @param height 條形碼高度
     * @return 條形碼的字節(jié)數據
     */
    public byte[] generateBarcodeImage(String content, int width, int height) {
        Code128Writer barcodeWriter = new Code128Writer();
        BitMatrix bitMatrix = null;
        try {
            bitMatrix = barcodeWriter.encode(content, BarcodeFormat.CODE_128, width, height);
            ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
            MatrixToImageConfig config = new MatrixToImageConfig(MatrixToImageConfig.BLACK, MatrixToImageConfig.WHITE);
            MatrixToImageWriter.writeToStream(bitMatrix, "PNG", outputStream, config);
            return outputStream.toByteArray();
        } catch (WriterException | IOException e) {
            e.printStackTrace();
            return null;
        }
    }
}

然后，修改BarcodeController以返回圖片的字節(jié)數據：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class BarcodeController {

    @Autowired
    private BarcodeService barcodeService;

    @GetMapping("/generate-barcode")
    public ResponseEntity<byte[]> generateBarcode(@RequestParam String content, @RequestParam int width, @RequestParam int height) {
        byte[] barcodeImage = barcodeService.generateBarcodeImage(content, width, height);
        if (barcodeImage != null) {
            HttpHeaders headers = new HttpHeaders();
            headers.setContentType(MediaType.IMAGE_PNG);
            return new ResponseEntity<>(barcodeImage, headers, HttpStatus.OK);
        } else {
            return new ResponseEntity<>(null, HttpStatus.INTERNAL_SERVER_ERROR);
        }
    }
}

現在，當你在Spring Boot, Spring Cloud 項目中訪問/generate-barcode端點并傳遞相應的參數時，它將生成一個條形碼并將其作為PNG圖片的字節(jié)數據返回。

到此這篇關于SpringBoot生成條形碼的方案詳解的文章就介紹到這了,更多相關SpringBoot生成條形碼內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: