How to Integrate Barcode4J with Java Applications Barcode generation is a common requirement in enterprise Java applications, especially for logistics, inventory management, and ticketing systems. Barcode4J is a flexible, open-source barcode generation library written in Java. It supports formats like Code 128, EAN-13, and QR codes.
Here is a step-by-step guide to integrating Barcode4J into your Java application. 1. Add Dependencies to Your Project
To use Barcode4J, you need to add the library to your project’s build configuration. For Maven (pom.xml):
build.gradle): implementation ‘net.sf.barcode4j:barcode4j:2.1’ Use code with caution. 2. Generate a Barcode Image in Java
The quickest way to generate a barcode is by using a specific generator class (like Code128Bean) and an image builder (BitmapCanvasProvider).
Here is a complete example that generates a Code 128 barcode and saves it as a PNG file:
import java.io.File; import java.io.FileOutputStream; import java.io.OutputStream; import java.awt.image.BufferedImage; import org.krysalis.barcode4j.impl.code128.Code128Bean; import org.krysalis.barcode4j.output.bitmap.BitmapCanvasProvider; import org.krysalis.barcode4j.tools.UnitConv; public class BarcodeGenerator { public static void generateCode128(String text, String filePath) { try { // 1. Create the barcode bean Code128Bean bean = new Code128Bean(); // 2. Configure the barcode parameters final int dpi = 150; bean.setModuleWidth(UnitConv.in2mm(1.0f / dpi)); // width of the narrowest bar bean.doQuietZone(true); // add white space around the barcode // 3. Open the output file stream File outputFile = new File(filePath); OutputStream out = new FileOutputStream(outputFile); try { // 4. Set up the canvas provider for image generation BitmapCanvasProvider canvas = new BitmapCanvasProvider( out, “image/x-png”, dpi, BufferedImage.TYPE_BYTE_BINARY, false, 0); // 5. Generate the barcode bean.generateBarcode(canvas, text); // 6. Signal the end of generation canvas.finish(); } finally { out.close(); } System.out.println(“Barcode successfully saved to: ” + filePath); } catch (Exception e) { e.printStackTrace(); } } public static void main(String[] args) { generateCode128(“JAVA-BARCODE-123”, “barcode.png”); } } Use code with caution. 3. Understanding the Core Components
When integrating Barcode4J, you will work primarily with three concepts:
Barcode Beans: These are classes representing specific barcode symbologies (e.g., Code39Bean, EAN13Bean, DataMatrixBean). You use them to set properties like height, module width, and human-readable text placement.
Canvas Providers: These determine the output format. BitmapCanvasProvider handles raster images (PNG, JPEG), while SVGCanvasProvider creates vector-based SVG graphics.
Unit Conversion: Barcode4J native units are millimeters (mm). Use the UnitConv utility class to convert pixels or inches to millimeters easily. 4. Advanced: XML Configuration (Optional)
If you prefer not to hardcode barcode properties, Barcode4J allows you to define barcode structures in an XML file. You can load this configuration dynamically using the BarcodeUtil class:
import org.krysalis.barcode4j.BarcodeGenerator; import org.krysalis.barcode4j.BarcodeUtil; import org.avalon.framework.configuration.Configuration; import org.avalon.framework.configuration.DefaultConfigurationBuilder; // Load configuration from an XML file DefaultConfigurationBuilder builder = new DefaultConfigurationBuilder(); Configuration cfg = builder.buildFromFile(new File(“barcode-config.xml”)); // Instantiate the generator dynamically BarcodeGenerator gen = BarcodeUtil.getInstance().createBarcodeGenerator(cfg); Use code with caution. Conclusion
Integrating Barcode4J with Java is a straightforward process requiring minimal code. By using its bean-based architecture, you can generate a wide array of 1D and 2D barcode patterns, customize their visual scales, and export them directly to file streams or web responses. If you want to tailor this implementation, tell me:
What barcode symbology do you need? (e.g., QR Code, EAN-13, Code 39)
What is the output target? (e.g., saving a file, rendering in a JSF/Spring Web page, or embedding in a PDF report) Do you need help handling byte arrays or Base64 encoding?
I can provide the exact code snippets or setup configurations for your use case.
Leave a Reply