Home » Android » barcode – Integrating the ZXing library directly into my Android application

barcode – Integrating the ZXing library directly into my Android application

Posted by: admin March 11, 2020 Leave a comment

Questions:

I’m writing this in mere desperation 🙂 I’ve been assigned to make a standalone barcode scanner (as a proof of concept) to an Android 1.6 phone.

For this i’ve discovered the ZXing library.

I’ve googled, read related topics here on StackOverflow used common sence and so forth. Nothing seemed to have helped, and i just can’t punch a hole on this mentale blockade :/

I know it to be possible, to use the lib, and create your own standalone barcode scanner. I’ve read that using the “Barcode Scanner” provided by the Zxing folks, is by far the easiest solution (via Intent). Unfortunately this is not an option, and a standalone app is desired.

So to sum up my problem :

  1. How to integrate ZXing source lib into my Android Code project through Eclipse?
  2. When integrated … how to make use of the lib, to “load” the scanning function?
  3. A step to step guide is almost prefered because i just started working in Eclipse.

I’ve tried to make my code project dependant of the Android folder from the ZXing source folder. When i do so, a handfull errors emerge, mostly concerning ‘org.apache’ (??)

I just can’t figure it out … so a few hints would be most helpfull.

In advance, thank you 🙂

How to&Answers:

UPDATE! – SOLVED + GUIDE

I’ve managed to figure it out 🙂 And down below you can read step-by-step guide so it hopefully can help others with the same problem as I had 😉

  1. Install Apache Ant – (See this YouTube video for config help)
  2. Download the ZXing source from ZXing homepage and extract it
  3. With the use of Windows Commandline (Run->CMD) navigate to the root directory of the downloaded zxing src.
  4. In the commandline window – Type ant -f core/build.xml press enter and let Apache work it’s magic [having issues?]
  5. Enter Eclipse -> new Android Project, based on the android folder in the directory you just extracted
  6. Right-click project folder -> Properties -> Java Build Path -> Library -> Add External JARs…
  7. Navigate to the newly extracted folder and open the core directory and select core.jar … hit enter!

Now you just have to correct a few errors in the translations and the AndroidManifest.xml file 🙂 Now you can happily compile, and you will now have a working standalone barcode scanner app, based on the ZXing source 😉

Happy coding guys – I hope it can help others 🙂

Answer:

Here is a step-by-step guide on how to generate and display QR code using ZXing library without having to install the third-party application. Note: you don’t have to build ZXing with ANT or any other build tool. The file core.jar is available in the released zip archive (read below).

  1. Download the latest release of ZXing. — (ZXing-*.zip)
  2. Extract this zip archive and find core.jar under core/ directory.
  3. If you are using Eclipse IDE, drag and drop core.jar to the libs directory of your Android project. When asked, select Copy.
  4. Copy the two classes given below (Contents.java & QRCodeEncoder.java) to the main package of your Android project.
  5. Create an ImageView item in your Activity to display the generated QR code in if you don’t have one already. An example is given below:
  6. Use the code snippet below to generate the QR code in Bitmap format and display it in an ImageView.

Here is an ImageView element to add to your Activity layout XML file:

<ImageView 
    android:id="@+id/qrCode"
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"
    android:layout_marginTop="50dp"
    android:layout_centerHorizontal="true"/>

Code snippet:

// ImageView to display the QR code in.  This should be defined in 
// your Activity's XML layout file
ImageView imageView = (ImageView) findViewById(R.id.qrCode);

String qrData = "Data I want to encode in QR code";
int qrCodeDimention = 500;

QRCodeEncoder qrCodeEncoder = new QRCodeEncoder(qrData, null,
        Contents.Type.TEXT, BarcodeFormat.QR_CODE.toString(), qrCodeDimention);

try {
    Bitmap bitmap = qrCodeEncoder.encodeAsBitmap();
    imageView.setImageBitmap(bitmap);
} catch (WriterException e) {
    e.printStackTrace();
}

Here is Contents.java

//
// * Copyright (C) 2008 ZXing authors
// * 
// * Licensed under the Apache License, Version 2.0 (the "License");
// * you may not use this file except in compliance with the License.
// * You may obtain a copy of the License at
// * 
// * http://www.apache.org/licenses/LICENSE-2.0
// * 
// * Unless required by applicable law or agreed to in writing, software
// * distributed under the License is distributed on an "AS IS" BASIS,
// * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// * See the License for the specific language governing permissions and
// * limitations under the License.
// 

import android.provider.ContactsContract;

public final class Contents {
    private Contents() {
    }

    public static final class Type {

     // Plain text. Use Intent.putExtra(DATA, string). This can be used for URLs too, but string
     // must include "http://" or "https://".
        public static final String TEXT = "TEXT_TYPE";

        // An email type. Use Intent.putExtra(DATA, string) where string is the email address.
        public static final String EMAIL = "EMAIL_TYPE";

        // Use Intent.putExtra(DATA, string) where string is the phone number to call.
        public static final String PHONE = "PHONE_TYPE";

        // An SMS type. Use Intent.putExtra(DATA, string) where string is the number to SMS.
        public static final String SMS = "SMS_TYPE";

        public static final String CONTACT = "CONTACT_TYPE";

        public static final String LOCATION = "LOCATION_TYPE";

        private Type() {
        }
    }

    public static final String URL_KEY = "URL_KEY";

    public static final String NOTE_KEY = "NOTE_KEY";

    // When using Type.CONTACT, these arrays provide the keys for adding or retrieving multiple phone numbers and addresses.
    public static final String[] PHONE_KEYS = {
            ContactsContract.Intents.Insert.PHONE, ContactsContract.Intents.Insert.SECONDARY_PHONE,
            ContactsContract.Intents.Insert.TERTIARY_PHONE
    };

    public static final String[] PHONE_TYPE_KEYS = {
            ContactsContract.Intents.Insert.PHONE_TYPE,
            ContactsContract.Intents.Insert.SECONDARY_PHONE_TYPE,
            ContactsContract.Intents.Insert.TERTIARY_PHONE_TYPE
    };

    public static final String[] EMAIL_KEYS = {
            ContactsContract.Intents.Insert.EMAIL, ContactsContract.Intents.Insert.SECONDARY_EMAIL,
            ContactsContract.Intents.Insert.TERTIARY_EMAIL
    };

    public static final String[] EMAIL_TYPE_KEYS = {
            ContactsContract.Intents.Insert.EMAIL_TYPE,
            ContactsContract.Intents.Insert.SECONDARY_EMAIL_TYPE,
            ContactsContract.Intents.Insert.TERTIARY_EMAIL_TYPE
    };
}

And QRCodeEncoder.java

Answer:

The

unfortunately didn’t work for me.

This is what worked for me:

Please find the link here:
https://github.com/journeyapps/zxing-android-embedded

Answer:

Having issues building with ANT? Keep reading

If ant -f core/build.xml
says something like:

then set your JAVA_HOME environment variable to the proper java folder. I found tools.jar in my (for Windows):

so I set my JAVA_HOME to:

the reason for the shorter syntax I found at some site which says:

“It is strongly advised that you
choose an installation directory that
does not include spaces in the path
name (e.g., do NOT install in
C:\Program Files). If Java is
installed in such a directory, it is
critical to set the JAVA_HOME
environment variable to a path that
does not include spaces (e.g.,
C:\Progra~1); failure to do this will
result in exceptions thrown by some
programs that depend on the value of
JAVA_HOME.”

I then relaunched cmd (important because DOS shell only reads env vars upon launching, so changing an env var will require you to use a new shell to get the updated value)

and finally the ant -f core/build.xml worked.

Answer:

Since some of the answers are outdated, I would like to provide my own –

To integrate ZXing library into your Android app as suggested by their Wiki, you need to add 2 Java files to your project:

Then in Android Studio add the following line to build.gradle file:

Or if still using Eclipse with ADT-plugin add core.jar file to the libs subdirectory of your project (here fullscreen Windows and fullscreen Mac):

Windows screenshot

Finally add this code to your MainActivity.java:

The resulting app will ask to install and start Barcode Scanner app by ZXing (which will return to your app automatically after scanning):

Barcode Scanner app

Additionally, if you would like to build and run the ZXing Test app as inspiration for your own app:

ZXing Test app

Then you need 4 Java files from GitHub:

  • BenchmarkActivity.java
  • BenchmarkAsyncTask.java
  • BenchmarkItem.java
  • ZXingTestActivity.java

And 3 Jar files from Maven repository:

  • core.jar
  • android-core.jar
  • android-integration.jar

(You can build the Jar files yourself with mvn package – if your check out ZXing from GitHub and install ant and maven tools at your computer).

Note: if your project does not recognize the Jar files, you might need to up the Java version in the Project Properties:

properties screenshot

Answer:

Have you seen the wiki pages on the zxing website? It seems you might find GettingStarted, DeveloperNotes and ScanningViaIntent helpful.

Answer:

Put

into your Gradle dependencies. As easy as that. Prior to using Android Studio and Gradle build system.

Answer:

If you just need the core.jar from zxing, you can skip that process and get the pre-built JARs from the GettingStarted wiki page

Latest ZXing (2.2) doesn’t have core.jar under core folder but you can obtain the core.jar from the zxing Maven repository here

Answer:

Step by step to setup zxing 3.2.1 in eclipse

  1. Download zxing-master.zip from “https://github.com/zxing/zxing
  2. Unzip zxing-master.zip, Use eclipse to import “android” project in zxing-master
  3. Download core-3.2.1.jar from “http://repo1.maven.org/maven2/com/google/zxing/core/3.2.1/
  4. Create “libs” folder in “android” project and paste cor-3.2.1.jar into the libs folder
  5. Click on project: choose “properties” -> “Java Compiler” to change level to 1.7. Then click on “Android” change “Project build target” to android 4.4.2+, because using 1.7 requires compiling with Android 4.4
  6. If “CameraConfigurationUtils.java” don’t exist in “zxing-master/android/app/src/main/java/com/google/zxing/client/android/camera/”. You can copy it from “zxing-master/android-core/src/main/java/com/google/zxing/client/android/camera/” and paste to your project.
  7. Clean and build project. If your project show error about “switch – case”, you should change them to “if – else”.
  8. Completed. Clean and build project.
  9. Reference link: Using ZXing to create an android barcode scanning app

Answer:

I tried all possible ways to achieve this and then I discovered Minified version of xZing by JourneyApps. I have ported that for eclipse and shared on GitHub.

If you are using eclipse use this project:-

https://github.com/hiteshsahu/XZing-Barcode-Scanner-Minified-Eclipse

If you are using Studio use this project :-

https://github.com/journeyapps/zxing-android-embedded

Advantages

  1. Inbuilt Barcode scanner in your App do not required to install third party apps using playstore.

  2. You dont need to get confused between Core,Android client etc jars simply drop this packages and relevent layouts in your project and you are good to go. Only Jar required is com.google.zxing:core:3.2.0 which you can download from

    http://mvnrepository.com/artifact/com.google.zxing/core/3.2.0

  3. No need to add tons of packages see images below for comparison

Before :-

enter image description here

After :-

enter image description here

  1. Most important part is they are highly customizable ie. you can add flash light, use it in fragment and support orientation change.

  2. You can use this Capture activity in Cordova App for barcode scanneing.

your capture activity in app manifest would look like this

and plugin will look like this

Happy Integration !!

Answer:

The zxing guys have made it easier to create a android project with 1.7. Its not as painful as it used to be. This is a quick blog for anyone who would like to create a zxing project for android quickly.

  • Checkout the zxing sources from zxing.org
  • Create a Android project on your eclipse
  • Delete main.xml
  • Right click on “src” directory and hit import. Browse to the following directories in the order mentioned. As you add them for import one by one, ensure that you have the src directory in the edit field of the import wizard. And that you select only the “com” directory on the left directory tree. Do not select src.
  • core
  • android-integration
  • android
  • Ensure that your android sdk version is 9, anything lesser and androidmanifest.xml will cry.
  • Strings.xml in one of the languages will crib, just put a / before the ‘ character

A android project for zxing 1.7 (June 20 checkout).

http://www.4shared.com/file/bFx8Y5Ys/zXingJune2010.html (NOT AVAILABLE ANYMORE)

Answer:

Why use an external lib, when google play services (since version 7.8.0) includes a barcode decoder.

Answer:

I just wrote a method, which decodes generated bar-codes, Bitmap to String.

It does exactly what is being requested, just without the CaptureActivity

Therefore, one can skip the android-integration library in the build.gradle :

The method as following (which actually decodes generated bar-codes, within a jUnit test):

Answer:

I have recently used google mobile vision in both ios and android. I highly recommend to use Google Barcode Scan. It is pretty responsive with any orientation and processing time is pretty fast. It is called Google Mobile Vision.

The Barcode Scanner API detects barcodes in real time in any
orientation. You can also detect and parse several barcodes in
different formats at the same time.

https://developers.google.com/vision/

https://codelabs.developers.google.com/codelabs/bar-codes/#0

Answer:

Much Easier approach.

Just include dependency in your app level gradle file

Define one button in your xml file and and write below code in Java file in OnCreate()and inside the OnClick listener of button

And write below code after OnCreate() of the Java file

Answer:

This library works like a charm, easy to integrate and use. https://github.com/dm77/barcodescanner