Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/raonigabriel/spring-qrcode-example

Demonstrates some of the capabilities of the Spring Boot framework through a small, simple example.
https://github.com/raonigabriel/spring-qrcode-example

java microservice qrcode spring-boot zxing

Last synced: 8 days ago
JSON representation

Demonstrates some of the capabilities of the Spring Boot framework through a small, simple example.

Host: GitHub
URL: https://github.com/raonigabriel/spring-qrcode-example
Owner: raonigabriel
License: apache-2.0
Created: 2015-11-24T15:00:12.000Z (about 9 years ago)
Default Branch: master
Last Pushed: 2023-03-06T06:57:17.000Z (almost 2 years ago)
Last Synced: 2023-03-06T17:34:04.075Z (almost 2 years ago)
Topics: java, microservice, qrcode, spring-boot, zxing
Language: Java
Size: 150 KB
Stars: 24
Watchers: 2
Forks: 17
Open Issues: 3
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        [![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=raonigabriel_spring-qrcode-example&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=raonigabriel_spring-qrcode-example)

![Maven Build](https://github.com/raonigabriel/spring-qrcode-example/workflows/Maven%20Build/badge.svg?branch=master)

[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=raonigabriel_spring-qrcode-example&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=raonigabriel_spring-qrcode-example)

[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=raonigabriel_spring-qrcode-example&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=raonigabriel_spring-qrcode-example)

[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=raonigabriel_spring-qrcode-example&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=raonigabriel_spring-qrcode-example)

[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=raonigabriel_spring-qrcode-example&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=raonigabriel_spring-qrcode-example)

[![Libraries](https://img.shields.io/librariesio/github/raonigabriel/spring-qrcode-example)](https://libraries.io/github/raonigabriel/spring-qrcode-example)

[![Open in Remote - Containers](https://img.shields.io/static/v1?label=Remote%20-%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/raonigabriel/spring-qrcode-example)

Spring Boot QrCode Example

-------------------

Demonstrates some capabilities of the Spring Boot framework through a small, simple example.

After reviewing this example, you should have a good understanding of what Spring Boot can do and get a feel for how easy it is to use.

#Features:

1. [Spring Boot 2.7.x](https://github.com/raonigabriel/spring-qrcode-example/blob/master/pom.xml#L39), supporting fully executable JARs for Linux based operating systems

2. WebFlux rest controller to [generate qrcode images](https://github.com/raonigabriel/spring-qrcode-example/blob/master/src/main/java/com/github/raonigabriel/qrcode/SpringExampleApp.java#L54)

  1. Produces binary [Content-Type (PNG)](https://github.com/raonigabriel/spring-qrcode-example/blob/master/src/main/java/com/github/raonigabriel/qrcode/SpringExampleApp.java#L53)

  2. HTTP header manipulation [(Cache-Control)](https://github.com/raonigabriel/spring-qrcode-example/blob/master/src/main/java/com/github/raonigabriel/qrcode/SpringExampleApp.java#L56)

  3. Java [Exception translation](https://github.com/raonigabriel/spring-qrcode-example/blob/master/src/main/java/com/github/raonigabriel/qrcode/SpringExampleApp.java#L73) to HTTP status code

  4. Manual cache eviction [(HTTP DELETE)](https://github.com/raonigabriel/spring-qrcode-example/blob/master/src/main/java/com/github/raonigabriel/qrcode/SpringExampleApp.java#L62)

  5. CORS enabled [(GET, DELETE)](https://github.com/raonigabriel/spring-qrcode-example/blob/master/src/main/java/com/github/raonigabriel/qrcode/SpringExampleApp.java#L40)

3. [Reactive processing](https://github.com/raonigabriel/spring-qrcode-example/blob/master/src/main/java/com/github/raonigabriel/qrcode/ImageService.java#L35) (for the image creation)

  1. Uses the [Fast Java QrCode Generator library](https://github.com/nayuki/QR-Code-generator/tree/master/java-fast) by [nayuki](https://github.com/nayuki).

4. Spring IoC ([Service](https://github.com/raonigabriel/spring-qrcode-example/blob/master/src/main/java/com/github/raonigabriel/qrcode/ImageService.java#L29), [Autowired](https://github.com/raonigabriel/spring-qrcode-example/blob/master/src/main/java/com/github/raonigabriel/qrcode/SpringExampleApp.java#L47))

5. [Backend caching](https://github.com/raonigabriel/spring-qrcode-example/blob/master/src/main/java/com/github/raonigabriel/qrcode/ImageService.java#L30) (Spring "simple" memory-based ConcurrentHashMap)

6. Scheduled tasks. Automatic cache eviction, [every 30 minutes](https://github.com/raonigabriel/spring-qrcode-example/blob/master/src/main/java/com/github/raonigabriel/qrcode/SpringExampleApp.java#L60).

7. [Logging](https://github.com/raonigabriel/spring-qrcode-example/blob/master/src/main/java/com/github/raonigabriel/qrcode/ImageService.java#L33) (sl4j + logback)

8. Only 2 classes, about 100 lines of code!!! 

9. Small. Final JAR includes everything (it self-contained) and it's about 18 MB

To get the code:

-------------------

Clone the repository:

    $ git clone https://github.com/raonigabriel/spring-qrcode-example.git

If this is your first time using Github, review http://help.github.com to learn the basics.

To run the application:

-------------------	

From the command line with Maven:

    $ cd spring-qrcode-example

    $ mvn spring-boot:run 

From the command line with Linux:

    $ cd spring-qrcode-example/target

    $ ./spring-qrcode-example-x.y.z.jar

Using docker:

    $ docker run -d --name qrcode-service --rm -p 8080:8080 raonigabriel/spring-qrcode-example

Access the deployed web application [http://localhost:8080/qrcode?text=Hello%20World%20From%20Spring](http://localhost:8080/qrcode?text=Hello%20World%20From%20Spring)

or

In your preferred IDE such as SpringSource Tool Suite (STS) or IDEA:

* Import spring-qrcode-example as a Maven Project

## License

Code on package "com.github.raonigabriel" **(my code)** is released under the [Apache 2.0 license](http://www.apache.org/licenses/LICENSE-2.0.html)

Code under on "io.nayuki.fastqrcodegen" **(nayuki code)** is released under the [MIT license](https://choosealicense.com/licenses/mit/)

## Disclaimer

* This code comes with no warranty. Use it at your own risk.

* I don't like Apple. Fuck off, fan-boys.

* I don't like left-winged snowflakes. Fuck off, code-covenant. 

* I will call my branches the old way. Long live **master**, fuck-off renaming.