# OkapiBarcode

**Repository Path**: joo2019/OkapiBarcode

## Basic Information

- **Project Name**: OkapiBarcode
- **Description**: OkapiBarcode 是一个 Java 的条形码编码程序，支持超过 50 种编码标准
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: https://www.oschina.net/p/okapibarcode
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2025-08-21
- **Last Updated**: 2025-08-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Okapi Barcode

[![License](https://img.shields.io/badge/License-Apache%202-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0.html)
[![Maven Central](https://maven-badges.herokuapp.com/maven-central/uk.org.okapibarcode/okapibarcode/badge.svg)](https://maven-badges.herokuapp.com/maven-central/uk.org.okapibarcode/okapibarcode)
[![Reproducible Builds](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/jvm-repo-rebuild/reproducible-central/master/content/uk/org/okapibarcode/okapibarcode/badge.json)](https://github.com/jvm-repo-rebuild/reproducible-central/blob/master/content/uk/org/okapibarcode/okapibarcode/README.md)
[![Code Coverage](https://codecov.io/gh/woo-j/OkapiBarcode/branch/master/graph/badge.svg)](https://codecov.io/gh/woo-j/OkapiBarcode/branch/master)

Okapi Barcode is an open-source barcode generator written entirely in Java,
supporting over 50 encoding standards, including all ISO standards. Okapi
Barcode is based on [Zint](https://zint.org.uk/), an open-source barcode
encoding library developed in C, and builds on the years of work that have
been invested in that project.

### Supported Symbologies

* [Australia Post](src/main/java/uk/org/okapibarcode/backend/AustraliaPost.java) variants:
  * Standard Customer
  * Reply Paid
  * Routing
  * Redirection
* [Aztec Code](src/main/java/uk/org/okapibarcode/backend/AztecCode.java)
* [Aztec Runes](src/main/java/uk/org/okapibarcode/backend/AztecRune.java)
* [Channel Code](src/main/java/uk/org/okapibarcode/backend/ChannelCode.java)
* [Codabar](src/main/java/uk/org/okapibarcode/backend/Codabar.java)
* [Codablock F](src/main/java/uk/org/okapibarcode/backend/CodablockF.java)
* [Code 11](src/main/java/uk/org/okapibarcode/backend/Code11.java)
* [Code 128](src/main/java/uk/org/okapibarcode/backend/Code128.java)
* [Code 16k](src/main/java/uk/org/okapibarcode/backend/Code16k.java)
* [Code 2 of 5](src/main/java/uk/org/okapibarcode/backend/Code2Of5.java) variants:
  * Matrix 2 of 5
  * Industrial 2 of 5
  * IATA 2 of 5
  * Datalogic 2 of 5
  * Interleaved 2 of 5
  * ITF-14
  * Deutsche Post Leitcode
  * Deutsche Post Identcode
* [Code 32](src/main/java/uk/org/okapibarcode/backend/Code32.java) (Italian Pharmacode)
* [Code 3 of 9](src/main/java/uk/org/okapibarcode/backend/Code3Of9.java) (Code 39)
* [Code 3 of 9 Extended](src/main/java/uk/org/okapibarcode/backend/Code3Of9Extended.java) (Code 39 Extended)
* [Code 49](src/main/java/uk/org/okapibarcode/backend/Code49.java)
* [Code 93](src/main/java/uk/org/okapibarcode/backend/Code93.java)
* [Code One](src/main/java/uk/org/okapibarcode/backend/CodeOne.java)
* [Data Matrix](src/main/java/uk/org/okapibarcode/backend/DataMatrix.java)
* [DPD Code](src/main/java/uk/org/okapibarcode/backend/DpdCode.java)
* [Dutch Post KIX Code](src/main/java/uk/org/okapibarcode/backend/KixCode.java)
* [EAN](src/main/java/uk/org/okapibarcode/backend/Ean.java) variants:
  * EAN-13
  * EAN-8
* [Grid Matrix](src/main/java/uk/org/okapibarcode/backend/GridMatrix.java)
* [GS1 Composite](src/main/java/uk/org/okapibarcode/backend/Composite.java)
* [GS1 DataBar](src/main/java/uk/org/okapibarcode/backend/DataBar14.java) variants:
  * GS1 DataBar
  * GS1 DataBar Stacked
  * GS1 DataBar Stacked Omnidirectional
* [GS1 DataBar Expanded](src/main/java/uk/org/okapibarcode/backend/DataBarExpanded.java) variants:
  * GS1 DataBar Expanded
  * GS1 DataBar Expanded Stacked
* [GS1 DataBar Limited](src/main/java/uk/org/okapibarcode/backend/DataBarLimited.java)
* [Japan Post](src/main/java/uk/org/okapibarcode/backend/JapanPost.java)
* [Korea Post](src/main/java/uk/org/okapibarcode/backend/KoreaPost.java)
* [LOGMARS](src/main/java/uk/org/okapibarcode/backend/Logmars.java)
* [MaxiCode](src/main/java/uk/org/okapibarcode/backend/MaxiCode.java)
* [MSI](src/main/java/uk/org/okapibarcode/backend/MsiPlessey.java) (Modified Plessey)
* [PDF417](src/main/java/uk/org/okapibarcode/backend/Pdf417.java) variants:
  * PDF417
  * Truncated PDF417 (Compact PDF417)
  * Macro PDF417
  * Micro PDF417
* [Pharmacode](src/main/java/uk/org/okapibarcode/backend/Pharmacode.java)
* [Pharmacode Two-Track](src/main/java/uk/org/okapibarcode/backend/Pharmacode2Track.java)
* [Plessey](src/main/java/uk/org/okapibarcode/backend/Plessey.java) (UK Plessey)
* [POSTNET / PLANET](src/main/java/uk/org/okapibarcode/backend/Postnet.java)
* [QR Code](src/main/java/uk/org/okapibarcode/backend/QrCode.java)
* [Royal Mail 4 State](src/main/java/uk/org/okapibarcode/backend/RoyalMail4State.java) (RM4SCC)
* [Swiss QR Code](src/main/java/uk/org/okapibarcode/backend/SwissQrCode.java)
* [Telepen](src/main/java/uk/org/okapibarcode/backend/Telepen.java) variants:
  * Telepen
  * Telepen Numeric
* [UPC](src/main/java/uk/org/okapibarcode/backend/Upc.java) variants:
  * UPC-A
  * UPC-E
* [UPN QR](src/main/java/uk/org/okapibarcode/backend/UpnQr.java)
* [USPS OneCode](src/main/java/uk/org/okapibarcode/backend/UspsOneCode.java) (Intelligent Mail)

### Library Usage (Java)

Okapi Barcode JARs are available for download from [Maven Central](http://search.maven.org/#search|ga|1|uk.org.okapibarcode).

To generate barcode images in your own code using the Okapi Barcode library, use one of the symbology
classes linked above:

1. instantiate the barcode class,
2. customize any relevant settings,
3. invoke `setContent(String)`, and then
4. pass the barcode instance to one of the available renderers
([Java 2D](src/main/java/uk/org/okapibarcode/output/Java2DRenderer.java),
[PostScript](src/main/java/uk/org/okapibarcode/output/PostScriptRenderer.java),
[SVG](src/main/java/uk/org/okapibarcode/output/SvgRenderer.java))

```java
Code128 barcode = new Code128();
barcode.setFontName("Monospaced");
barcode.setFontSize(16);
barcode.setModuleWidth(2);
barcode.setBarHeight(50);
barcode.setHumanReadableLocation(HumanReadableLocation.BOTTOM);
barcode.setContent("123456789");

int width = barcode.getWidth();
int height = barcode.getHeight();

BufferedImage image = new BufferedImage(width, height, BufferedImage.TYPE_BYTE_GRAY);
Graphics2D g2d = image.createGraphics();
Java2DRenderer renderer = new Java2DRenderer(g2d, 1, Color.WHITE, Color.BLACK);
renderer.render(barcode);

ImageIO.write(image, "png", new File("code128.png"));
```

### Library Usage (Android)

If you'd like to use Okapi Barcode on the Android platform, the easiest approach is to use the
[SVG renderer](src/main/java/uk/org/okapibarcode/output/SvgRenderer.java) to render your barcode
to SVG, and then use a library like [AndroidSVG](https://bigbadaboom.github.io/androidsvg/) to
draw the resultant SVG image on an Android `Bitmap` or `Canvas`:

```java
Code128 barcode = new Code128();
barcode.setFontName("Monospaced");
barcode.setFontSize(16);
barcode.setModuleWidth(2);
barcode.setBarHeight(50);
barcode.setHumanReadableLocation(HumanReadableLocation.BOTTOM);
barcode.setContent("123456789");

ByteArrayOutputStream stream = new ByteArrayOutputStream();
SvgRenderer renderer = new SvgRenderer(stream, 1, Color.WHITE, Color.BLACK, true);
renderer.render(barcode);

String content = new String(stream.toByteArray(), StandardCharsets.UTF_8);
SVG svg = SVG.getFromString(content);
svg.renderToCanvas(canvas);
```

### GUI Usage

To use the Swing GUI, just run the [OkapiUI](src/main/java/uk/org/okapibarcode/gui/OkapiUI.java) class.
The GUI allows you to explore the supported barcode symbologies and test them with different configurations
and data.

![Okapi GUI Screenshot](okapi-gui-screenshot.png)

### Building

`gradlew check`: Compiles and runs all quality checks, including the unit tests.  
`gradlew fuzz`: Runs barcode encoding fuzz tests using [Jazzer](https://github.com/CodeIntelligenceTesting/jazzer).  
`gradlew jar`: Builds the JAR file.  
`gradlew publish`: Deploys to Maven Central (requires a modified `gradle.properties` file).  

### Recent Releases

#### Okapi Barcode 0.5.2
- QR Code: add support for structured append

#### Okapi Barcode 0.5.1
- Japanese Postal Code: fix bug encoding some letters
- Japanese Postal Code: throw exception if input data is too long
- PDF417, MicroPDF417: improve error messages
- JavaDoc improvements

#### Okapi Barcode 0.5.0
- Update GS1 AI validations per 2025 specifications
- Include license in JAR file

#### Okapi Barcode 0.4.9
- Codablock F: allow user to customize row height
- Codablock F: allow user to customize module width
- Codablock F: improve check digit calculation
- Codablock F: fix encodation bugs in various corner cases
- Add optional rotation parameter to all renderers

#### Okapi Barcode 0.4.8
- MaxiCode: improve handling of partial and malformed postal codes (modes 2 and 3)
- Code 11: allow empty content, if user requests it
- Micro QR Code: allow empty content, if user requests it
- Micro QR Code: fix last data character ignored during encoding in some scenarios

#### Okapi Barcode 0.4.7
- Update build toolchain from Java 17 to Java 21 (minimum target runtime remains Java 8)
- SVG and EPS output: round up canvas dimensions when using decimal magnification factor
- MaxiCode: reduce memory use during encoding
- QR Code: reduce encode time by about 25%

#### Okapi Barcode 0.4.6
- QR Code: allow FNC1 escape sequences in user-provided content
- Code 39 Extended: allow empty content, if user requests it
- QR Code: allow empty content, if user requests it
- UPC/EAN: allow empty content, if user requests it
- Telepen: allow empty content, if user requests it

#### Okapi Barcode 0.4.5
- Code 128: allow user to restrict the code sets used to encode data
- First [reproducible build](https://github.com/jvm-repo-rebuild/reproducible-central/)

#### Okapi Barcode 0.4.4
- Aztec Code: allow user to restrict sizes to compact or normal Aztec sizes

#### Okapi Barcode 0.4.3
- Add support for UPN QR
- Add support for DPD Code
- Add support for Swiss QR Code
- Add support for specifying ECI mode explicitly
- PDF417: add support for forcing byte compaction mode
- QR Code: add support for forcing byte compaction mode
- Code 39 Extended: allow customization of module width ratio
- PDF417: add support for automatic splitting of structured append symbols

#### Okapi Barcode 0.4.2
- PDF417: allow user to request byte compaction
- QR Code: improved encoding performance and efficiency
- Code 128: further optimize data encoding in some scenarios
- QR Code: fix broken Kanji encoding in some corner cases (found via fuzzing)
- Data Matrix: fix encoding of trailing extended ASCII characters in TEXT/C40 mode (found via fuzzing)
- Add `OkapiInputException` and `OkapiInternalException`, to distinguish user vs. library errors

#### Okapi Barcode 0.4.1
- DataBar Expanded: various small fixes and cleanup

#### Okapi Barcode 0.4.0
- Update minimum Java runtime requirement from Java 7 to Java 8
- Update build Java runtime from Java 8 to Java 17
- Channel Code: fix `NullPointerException` when channel count not specified
- MaxiCode: fix handling of custom quiet zones when rendering via `Java2DRenderer`
- Code 128: fix encoding of line feeds when combined with lowercase characters (found via fuzzing)
- Code 128: fix encoding of shifted characters which also use extended encoding (found via fuzzing)
- Code 128: never try to shift in or out of extended mode while in code set C (found via fuzzing)
- Code 128: always exit extended mode before switching to code set C (found via fuzzing)
- Data Matrix: fix incorrect encoding of single ASCII characters within X12 data (found via fuzzing)
- Refactor to remove most uses of AWT classes in core Okapi classes (for Android users)
- Rename `HumanReadableAlignment` to `TextAlignment`, move it to `graphics` package (for Android users)

#### Okapi Barcode 0.3.3

- GS1 Composite: avoid ArrayIndexOutOfBoundsException in some rare corner cases
- PDF417: add `setContent(byte[])` method for binary data
- PDF417: when using structured append (Macro PDF417), place padding before control block, not after
- PDF417: fix auto-calculation of row count when data is very small and column count is specified
- PDF417: add support for segment count and file name Macro PDF417 optional fields
- Royal Mail 4-State: fix bug in check digit calculation

#### Okapi Barcode 0.3.2

- MSI Plessey: allow empty content
- MSI Plessey: improve symbol configurability (module width ratio, check digit visibility)
- Add support for the original Plessey symbology (also known as UK Plessey)

#### Okapi Barcode 0.3.1

- Improve build times
- Code 128: allow empty content
- All GS1 symbols: improve GS1 AI validations
- Data Matrix: allow use of GS as the GS1 separator
- Data Matrix: fix data too long to fit in symbol issue
- Data Matrix: add trailing data characters to debug logs

#### Okapi Barcode 0.3.0

- POSTNET: improve symbol configurability (module width ratio, short and long height percentages)
- USPS OneCode: improve symbol configurability (module width ratio, short and long height percentages)