From 0c94126c933ee4d47c0c373d55c15b82cf0d4ada Mon Sep 17 00:00:00 2001 From: igorcampos-dev Date: Wed, 13 Aug 2025 20:49:56 -0300 Subject: [PATCH 1/8] feat(spring-jasper-example): initialize Spring Jasper example project with Docker and CI configuration --- .github/labeler.yml | 4 + .github/workflows/spring-jasper-example.yml | 68 +++++ pom.xml | 1 + spring-jasper-example/.dockerignore | 62 +++++ spring-jasper-example/.gitattributes | 2 + .../.github/workflows/maven.yml | 30 ++ spring-jasper-example/.gitignore | 32 +++ .../.mvn/wrapper/maven-wrapper.properties | 19 ++ spring-jasper-example/Dockerfile | 47 ++++ spring-jasper-example/README.md | 1 + spring-jasper-example/compose.yaml | 9 + spring-jasper-example/mvnw | 259 ++++++++++++++++++ spring-jasper-example/mvnw.cmd | 149 ++++++++++ spring-jasper-example/pom.xml | 63 +++++ .../SpringJasperExampleApplication.java | 13 + .../src/main/resources/application-prd.yml | 5 + .../src/main/resources/application.yml | 5 + 17 files changed, 769 insertions(+) create mode 100644 .github/workflows/spring-jasper-example.yml create mode 100644 spring-jasper-example/.dockerignore create mode 100644 spring-jasper-example/.gitattributes create mode 100644 spring-jasper-example/.github/workflows/maven.yml create mode 100644 spring-jasper-example/.gitignore create mode 100644 spring-jasper-example/.mvn/wrapper/maven-wrapper.properties create mode 100644 spring-jasper-example/Dockerfile create mode 100644 spring-jasper-example/README.md create mode 100644 spring-jasper-example/compose.yaml create mode 100755 spring-jasper-example/mvnw create mode 100644 spring-jasper-example/mvnw.cmd create mode 100644 spring-jasper-example/pom.xml create mode 100644 spring-jasper-example/src/main/java/com/io/example/SpringJasperExampleApplication.java create mode 100644 spring-jasper-example/src/main/resources/application-prd.yml create mode 100644 spring-jasper-example/src/main/resources/application.yml diff --git a/.github/labeler.yml b/.github/labeler.yml index 4cd6545..49ee866 100644 --- a/.github/labeler.yml +++ b/.github/labeler.yml @@ -10,6 +10,10 @@ - changed-files: - any-glob-to-any-file: 'spring-keycloak-example/**/*' +"project: spring-jasper-example": + - changed-files: + - any-glob-to-any-file: 'spring-jasper-example/**/*' + "type: dependency-upgrade": - changed-files: - any-glob-to-any-file: "**/pom.xml" diff --git a/.github/workflows/spring-jasper-example.yml b/.github/workflows/spring-jasper-example.yml new file mode 100644 index 0000000..fda9771 --- /dev/null +++ b/.github/workflows/spring-jasper-example.yml @@ -0,0 +1,68 @@ +name: spring-jasper-example CI Build + +on: + pull_request: + branches: [master] + paths: + - "spring-jasper-example/**" + types: + - opened + - synchronize + - reopened + +jobs: + + integration-tests: + name: Run Unit & Integration Tests + runs-on: ubuntu-latest + defaults: + run: + working-directory: spring-jasper-example + strategy: + matrix: + distribution: [ 'temurin' ] + java: [ '21' ] + steps: + - uses: actions/checkout@v5 + with: + fetch-depth: 0 + + - name: Set up JDK ${{ matrix.java }} + uses: actions/setup-java@v4.7.1 + with: + java-version: ${{ matrix.java }} + distribution: ${{ matrix.distribution }} + cache: 'maven' + - name: Build and analyze + run: ./mvnw clean verify + + health-check: + name: Health Check on Services + runs-on: ubuntu-latest + steps: + - name: Checkout repository and submodules + uses: actions/checkout@v5 + with: + submodules: true + + - name: Extract service names from docker compose + id: services + run: | + echo "services<> $GITHUB_OUTPUT + docker compose -f ./spring-jasper-example/compose.yaml config --services >> $GITHUB_OUTPUT + echo "EOF" >> $GITHUB_OUTPUT + + - name: Start containers with Compose Action + uses: hoverkraft-tech/compose-action@v2.3.0 + with: + compose-file: './spring-jasper-example/compose.yaml' + services: ${{ steps.services.outputs.services }} + up-flags: '--build' + down-flags: '--volumes' + + - name: Wait for containers to initialize + run: sleep 10 + + - name: Check container health + run: | + ./.github/scripts/check-container-health.sh "${{ steps.services.outputs.services }}" \ No newline at end of file diff --git a/pom.xml b/pom.xml index b06cdd8..3879c7d 100644 --- a/pom.xml +++ b/pom.xml @@ -15,6 +15,7 @@ spring-kafka-example spring-prometheus-grafana-example spring-keycloak-example + spring-jasper-example \ No newline at end of file diff --git a/spring-jasper-example/.dockerignore b/spring-jasper-example/.dockerignore new file mode 100644 index 0000000..8893889 --- /dev/null +++ b/spring-jasper-example/.dockerignore @@ -0,0 +1,62 @@ +# Include any files or directories that you don't want to be copied to your +# container here (e.g., local build artifacts, temporary files, etc.). +# +# For more help, visit the .dockerignore file reference guide at +# https://docs.docker.com/go/build-context-dockerignore/ + +**/.DS_Store +**/.classpath +**/.dockerignore +**/.env +**/.factorypath +**/.git +**/.gitignore +**/.idea +**/.project +**/.sts4-cache +**/.settings +**/.toolstarget +**/.vs +**/.vscode +**/.next +**/.cache +**/*.dbmdl +**/*.jfm +**/charts +**/docker-compose* +**/compose.y*ml +**/Dockerfile* +**/secrets.dev.yaml +**/values.dev.yaml +**/vendor +LICENSE +README.md +**/*.class +**/*.iml +**/*.ipr +**/*.iws +**/*.log +**/.apt_generated +**/.gradle +**/.gradletasknamecache +**/.nb-gradle +**/.springBeans +**/build +**/dist +**/gradle-app.setting +**/nbbuild +**/nbdist +**/nbproject/private +**/target +*.ctxt +.mtj.tmp +.mvn/timing.properties +buildNumber.properties +dependency-reduced-pom.xml +hs_err_pid* +pom.xml.next +pom.xml.releaseBackup +pom.xml.tag +pom.xml.versionsBackup +release.properties +replay_pid* \ No newline at end of file diff --git a/spring-jasper-example/.gitattributes b/spring-jasper-example/.gitattributes new file mode 100644 index 0000000..3b41682 --- /dev/null +++ b/spring-jasper-example/.gitattributes @@ -0,0 +1,2 @@ +/mvnw text eol=lf +*.cmd text eol=crlf diff --git a/spring-jasper-example/.github/workflows/maven.yml b/spring-jasper-example/.github/workflows/maven.yml new file mode 100644 index 0000000..b4d64c0 --- /dev/null +++ b/spring-jasper-example/.github/workflows/maven.yml @@ -0,0 +1,30 @@ +name: CI Build + +on: + push: + branches: + - "**" + +jobs: + build: + name: Build + runs-on: ubuntu-latest + strategy: + matrix: + distribution: [ 'temurin' ] + java: [ '21' ] + steps: + - uses: actions/checkout@v5 + + - name: Setup Java 21 + uses: actions/setup-java@v4 + with: + java-version: ${{ matrix.java }} + distribution: ${{ matrix.distribution }} + cache: 'maven' + + - name: Grant execute permission for mvnw + run: chmod +x mvnw + + - name: Build with Maven + run: ./mvnw clean verify \ No newline at end of file diff --git a/spring-jasper-example/.gitignore b/spring-jasper-example/.gitignore new file mode 100644 index 0000000..a71cd2b --- /dev/null +++ b/spring-jasper-example/.gitignore @@ -0,0 +1,32 @@ +target/ +.mvn/wrapper/maven-wrapper.jar +!**/src/main/**/target/ +!**/src/test/**/target/ + +### STS ### +.apt_generated +.classpath +.factorypath +.project +.settings +.springBeans +.sts4-cache + +### IntelliJ IDEA ### +.idea +*.iws +*.iml +*.ipr + +### NetBeans ### +/nbproject/private/ +/nbbuild/ +/dist/ +/nbdist/ +/.nb-gradle/ +build/ +!**/src/main/**/build/ +!**/src/test/**/build/ + +### VS Code ### +.vscode/ diff --git a/spring-jasper-example/.mvn/wrapper/maven-wrapper.properties b/spring-jasper-example/.mvn/wrapper/maven-wrapper.properties new file mode 100644 index 0000000..12fbe1e --- /dev/null +++ b/spring-jasper-example/.mvn/wrapper/maven-wrapper.properties @@ -0,0 +1,19 @@ +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. +wrapperVersion=3.3.2 +distributionType=only-script +distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.11/apache-maven-3.9.11-bin.zip diff --git a/spring-jasper-example/Dockerfile b/spring-jasper-example/Dockerfile new file mode 100644 index 0000000..e10b2ee --- /dev/null +++ b/spring-jasper-example/Dockerfile @@ -0,0 +1,47 @@ +FROM eclipse-temurin:21.0.8_9-jdk-jammy as deps + +WORKDIR /build + +COPY --chmod=0755 mvnw mvnw +COPY .mvn/ .mvn/ + +RUN --mount=type=bind,source=pom.xml,target=pom.xml \ + --mount=type=cache,target=/root/.m2 ./mvnw dependency:go-offline -DskipTests + +FROM deps as package + +WORKDIR /build + +COPY ./src src/ +RUN --mount=type=bind,source=pom.xml,target=pom.xml \ + --mount=type=cache,target=/root/.m2 \ + ./mvnw package -DskipTests && \ + mv target/$(./mvnw help:evaluate -Dexpression=project.artifactId -q -DforceStdout)-$(./mvnw help:evaluate -Dexpression=project.version -q -DforceStdout).jar target/app.jar + +FROM package as extract + +WORKDIR /build + +RUN java -Djarmode=layertools -jar target/app.jar extract --destination target/extracted + +FROM eclipse-temurin:21.0.8_9-jre-jammy AS final + +ARG UID=10001 +RUN adduser \ + --disabled-password \ + --gecos "" \ + --home "/nonexistent" \ + --shell "/sbin/nologin" \ + --no-create-home \ + --uid "${UID}" \ + appuser +USER appuser + +COPY --from=extract build/target/extracted/dependencies/ ./ +COPY --from=extract build/target/extracted/spring-boot-loader/ ./ +COPY --from=extract build/target/extracted/snapshot-dependencies/ ./ +COPY --from=extract build/target/extracted/application/ ./ + +EXPOSE 80 + +ENTRYPOINT [ "java", "org.springframework.boot.loader.launch.JarLauncher" ] \ No newline at end of file diff --git a/spring-jasper-example/README.md b/spring-jasper-example/README.md new file mode 100644 index 0000000..9f6ac56 --- /dev/null +++ b/spring-jasper-example/README.md @@ -0,0 +1 @@ +# spring-jasper-example diff --git a/spring-jasper-example/compose.yaml b/spring-jasper-example/compose.yaml new file mode 100644 index 0000000..96a0477 --- /dev/null +++ b/spring-jasper-example/compose.yaml @@ -0,0 +1,9 @@ +services: + + app: + build: + context: . + ports: + - "80:80" + environment: + SPRING_PROFILES_ACTIVE: prd \ No newline at end of file diff --git a/spring-jasper-example/mvnw b/spring-jasper-example/mvnw new file mode 100755 index 0000000..19529dd --- /dev/null +++ b/spring-jasper-example/mvnw @@ -0,0 +1,259 @@ +#!/bin/sh +# ---------------------------------------------------------------------------- +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you 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. +# ---------------------------------------------------------------------------- + +# ---------------------------------------------------------------------------- +# Apache Maven Wrapper startup batch script, version 3.3.2 +# +# Optional ENV vars +# ----------------- +# JAVA_HOME - location of a JDK home dir, required when download maven via java source +# MVNW_REPOURL - repo url base for downloading maven distribution +# MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven +# MVNW_VERBOSE - true: enable verbose log; debug: trace the mvnw script; others: silence the output +# ---------------------------------------------------------------------------- + +set -euf +[ "${MVNW_VERBOSE-}" != debug ] || set -x + +# OS specific support. +native_path() { printf %s\\n "$1"; } +case "$(uname)" in +CYGWIN* | MINGW*) + [ -z "${JAVA_HOME-}" ] || JAVA_HOME="$(cygpath --unix "$JAVA_HOME")" + native_path() { cygpath --path --windows "$1"; } + ;; +esac + +# set JAVACMD and JAVACCMD +set_java_home() { + # For Cygwin and MinGW, ensure paths are in Unix format before anything is touched + if [ -n "${JAVA_HOME-}" ]; then + if [ -x "$JAVA_HOME/jre/sh/java" ]; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + JAVACCMD="$JAVA_HOME/jre/sh/javac" + else + JAVACMD="$JAVA_HOME/bin/java" + JAVACCMD="$JAVA_HOME/bin/javac" + + if [ ! -x "$JAVACMD" ] || [ ! -x "$JAVACCMD" ]; then + echo "The JAVA_HOME environment variable is not defined correctly, so mvnw cannot run." >&2 + echo "JAVA_HOME is set to \"$JAVA_HOME\", but \"\$JAVA_HOME/bin/java\" or \"\$JAVA_HOME/bin/javac\" does not exist." >&2 + return 1 + fi + fi + else + JAVACMD="$( + 'set' +e + 'unset' -f command 2>/dev/null + 'command' -v java + )" || : + JAVACCMD="$( + 'set' +e + 'unset' -f command 2>/dev/null + 'command' -v javac + )" || : + + if [ ! -x "${JAVACMD-}" ] || [ ! -x "${JAVACCMD-}" ]; then + echo "The java/javac command does not exist in PATH nor is JAVA_HOME set, so mvnw cannot run." >&2 + return 1 + fi + fi +} + +# hash string like Java String::hashCode +hash_string() { + str="${1:-}" h=0 + while [ -n "$str" ]; do + char="${str%"${str#?}"}" + h=$(((h * 31 + $(LC_CTYPE=C printf %d "'$char")) % 4294967296)) + str="${str#?}" + done + printf %x\\n $h +} + +verbose() { :; } +[ "${MVNW_VERBOSE-}" != true ] || verbose() { printf %s\\n "${1-}"; } + +die() { + printf %s\\n "$1" >&2 + exit 1 +} + +trim() { + # MWRAPPER-139: + # Trims trailing and leading whitespace, carriage returns, tabs, and linefeeds. + # Needed for removing poorly interpreted newline sequences when running in more + # exotic environments such as mingw bash on Windows. + printf "%s" "${1}" | tr -d '[:space:]' +} + +# parse distributionUrl and optional distributionSha256Sum, requires .mvn/wrapper/maven-wrapper.properties +while IFS="=" read -r key value; do + case "${key-}" in + distributionUrl) distributionUrl=$(trim "${value-}") ;; + distributionSha256Sum) distributionSha256Sum=$(trim "${value-}") ;; + esac +done <"${0%/*}/.mvn/wrapper/maven-wrapper.properties" +[ -n "${distributionUrl-}" ] || die "cannot read distributionUrl property in ${0%/*}/.mvn/wrapper/maven-wrapper.properties" + +case "${distributionUrl##*/}" in +maven-mvnd-*bin.*) + MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ + case "${PROCESSOR_ARCHITECTURE-}${PROCESSOR_ARCHITEW6432-}:$(uname -a)" in + *AMD64:CYGWIN* | *AMD64:MINGW*) distributionPlatform=windows-amd64 ;; + :Darwin*x86_64) distributionPlatform=darwin-amd64 ;; + :Darwin*arm64) distributionPlatform=darwin-aarch64 ;; + :Linux*x86_64*) distributionPlatform=linux-amd64 ;; + *) + echo "Cannot detect native platform for mvnd on $(uname)-$(uname -m), use pure java version" >&2 + distributionPlatform=linux-amd64 + ;; + esac + distributionUrl="${distributionUrl%-bin.*}-$distributionPlatform.zip" + ;; +maven-mvnd-*) MVN_CMD=mvnd.sh _MVNW_REPO_PATTERN=/maven/mvnd/ ;; +*) MVN_CMD="mvn${0##*/mvnw}" _MVNW_REPO_PATTERN=/org/apache/maven/ ;; +esac + +# apply MVNW_REPOURL and calculate MAVEN_HOME +# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ +[ -z "${MVNW_REPOURL-}" ] || distributionUrl="$MVNW_REPOURL$_MVNW_REPO_PATTERN${distributionUrl#*"$_MVNW_REPO_PATTERN"}" +distributionUrlName="${distributionUrl##*/}" +distributionUrlNameMain="${distributionUrlName%.*}" +distributionUrlNameMain="${distributionUrlNameMain%-bin}" +MAVEN_USER_HOME="${MAVEN_USER_HOME:-${HOME}/.m2}" +MAVEN_HOME="${MAVEN_USER_HOME}/wrapper/dists/${distributionUrlNameMain-}/$(hash_string "$distributionUrl")" + +exec_maven() { + unset MVNW_VERBOSE MVNW_USERNAME MVNW_PASSWORD MVNW_REPOURL || : + exec "$MAVEN_HOME/bin/$MVN_CMD" "$@" || die "cannot exec $MAVEN_HOME/bin/$MVN_CMD" +} + +if [ -d "$MAVEN_HOME" ]; then + verbose "found existing MAVEN_HOME at $MAVEN_HOME" + exec_maven "$@" +fi + +case "${distributionUrl-}" in +*?-bin.zip | *?maven-mvnd-?*-?*.zip) ;; +*) die "distributionUrl is not valid, must match *-bin.zip or maven-mvnd-*.zip, but found '${distributionUrl-}'" ;; +esac + +# prepare tmp dir +if TMP_DOWNLOAD_DIR="$(mktemp -d)" && [ -d "$TMP_DOWNLOAD_DIR" ]; then + clean() { rm -rf -- "$TMP_DOWNLOAD_DIR"; } + trap clean HUP INT TERM EXIT +else + die "cannot create temp dir" +fi + +mkdir -p -- "${MAVEN_HOME%/*}" + +# Download and Install Apache Maven +verbose "Couldn't find MAVEN_HOME, downloading and installing it ..." +verbose "Downloading from: $distributionUrl" +verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName" + +# select .zip or .tar.gz +if ! command -v unzip >/dev/null; then + distributionUrl="${distributionUrl%.zip}.tar.gz" + distributionUrlName="${distributionUrl##*/}" +fi + +# verbose opt +__MVNW_QUIET_WGET=--quiet __MVNW_QUIET_CURL=--silent __MVNW_QUIET_UNZIP=-q __MVNW_QUIET_TAR='' +[ "${MVNW_VERBOSE-}" != true ] || __MVNW_QUIET_WGET='' __MVNW_QUIET_CURL='' __MVNW_QUIET_UNZIP='' __MVNW_QUIET_TAR=v + +# normalize http auth +case "${MVNW_PASSWORD:+has-password}" in +'') MVNW_USERNAME='' MVNW_PASSWORD='' ;; +has-password) [ -n "${MVNW_USERNAME-}" ] || MVNW_USERNAME='' MVNW_PASSWORD='' ;; +esac + +if [ -z "${MVNW_USERNAME-}" ] && command -v wget >/dev/null; then + verbose "Found wget ... using wget" + wget ${__MVNW_QUIET_WGET:+"$__MVNW_QUIET_WGET"} "$distributionUrl" -O "$TMP_DOWNLOAD_DIR/$distributionUrlName" || die "wget: Failed to fetch $distributionUrl" +elif [ -z "${MVNW_USERNAME-}" ] && command -v curl >/dev/null; then + verbose "Found curl ... using curl" + curl ${__MVNW_QUIET_CURL:+"$__MVNW_QUIET_CURL"} -f -L -o "$TMP_DOWNLOAD_DIR/$distributionUrlName" "$distributionUrl" || die "curl: Failed to fetch $distributionUrl" +elif set_java_home; then + verbose "Falling back to use Java to download" + javaSource="$TMP_DOWNLOAD_DIR/Downloader.java" + targetZip="$TMP_DOWNLOAD_DIR/$distributionUrlName" + cat >"$javaSource" <<-END + public class Downloader extends java.net.Authenticator + { + protected java.net.PasswordAuthentication getPasswordAuthentication() + { + return new java.net.PasswordAuthentication( System.getenv( "MVNW_USERNAME" ), System.getenv( "MVNW_PASSWORD" ).toCharArray() ); + } + public static void main( String[] args ) throws Exception + { + setDefault( new Downloader() ); + java.nio.file.Files.copy( java.net.URI.create( args[0] ).toURL().openStream(), java.nio.file.Paths.get( args[1] ).toAbsolutePath().normalize() ); + } + } + END + # For Cygwin/MinGW, switch paths to Windows format before running javac and java + verbose " - Compiling Downloader.java ..." + "$(native_path "$JAVACCMD")" "$(native_path "$javaSource")" || die "Failed to compile Downloader.java" + verbose " - Running Downloader.java ..." + "$(native_path "$JAVACMD")" -cp "$(native_path "$TMP_DOWNLOAD_DIR")" Downloader "$distributionUrl" "$(native_path "$targetZip")" +fi + +# If specified, validate the SHA-256 sum of the Maven distribution zip file +if [ -n "${distributionSha256Sum-}" ]; then + distributionSha256Result=false + if [ "$MVN_CMD" = mvnd.sh ]; then + echo "Checksum validation is not supported for maven-mvnd." >&2 + echo "Please disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2 + exit 1 + elif command -v sha256sum >/dev/null; then + if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | sha256sum -c >/dev/null 2>&1; then + distributionSha256Result=true + fi + elif command -v shasum >/dev/null; then + if echo "$distributionSha256Sum $TMP_DOWNLOAD_DIR/$distributionUrlName" | shasum -a 256 -c >/dev/null 2>&1; then + distributionSha256Result=true + fi + else + echo "Checksum validation was requested but neither 'sha256sum' or 'shasum' are available." >&2 + echo "Please install either command, or disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." >&2 + exit 1 + fi + if [ $distributionSha256Result = false ]; then + echo "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised." >&2 + echo "If you updated your Maven version, you need to update the specified distributionSha256Sum property." >&2 + exit 1 + fi +fi + +# unzip and move +if command -v unzip >/dev/null; then + unzip ${__MVNW_QUIET_UNZIP:+"$__MVNW_QUIET_UNZIP"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -d "$TMP_DOWNLOAD_DIR" || die "failed to unzip" +else + tar xzf${__MVNW_QUIET_TAR:+"$__MVNW_QUIET_TAR"} "$TMP_DOWNLOAD_DIR/$distributionUrlName" -C "$TMP_DOWNLOAD_DIR" || die "failed to untar" +fi +printf %s\\n "$distributionUrl" >"$TMP_DOWNLOAD_DIR/$distributionUrlNameMain/mvnw.url" +mv -- "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain" "$MAVEN_HOME" || [ -d "$MAVEN_HOME" ] || die "fail to move MAVEN_HOME" + +clean || : +exec_maven "$@" diff --git a/spring-jasper-example/mvnw.cmd b/spring-jasper-example/mvnw.cmd new file mode 100644 index 0000000..249bdf3 --- /dev/null +++ b/spring-jasper-example/mvnw.cmd @@ -0,0 +1,149 @@ +<# : batch portion +@REM ---------------------------------------------------------------------------- +@REM Licensed to the Apache Software Foundation (ASF) under one +@REM or more contributor license agreements. See the NOTICE file +@REM distributed with this work for additional information +@REM regarding copyright ownership. The ASF licenses this file +@REM to you under the Apache License, Version 2.0 (the +@REM "License"); you may not use this file except in compliance +@REM with the License. You may obtain a copy of the License at +@REM +@REM http://www.apache.org/licenses/LICENSE-2.0 +@REM +@REM Unless required by applicable law or agreed to in writing, +@REM software distributed under the License is distributed on an +@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +@REM KIND, either express or implied. See the License for the +@REM specific language governing permissions and limitations +@REM under the License. +@REM ---------------------------------------------------------------------------- + +@REM ---------------------------------------------------------------------------- +@REM Apache Maven Wrapper startup batch script, version 3.3.2 +@REM +@REM Optional ENV vars +@REM MVNW_REPOURL - repo url base for downloading maven distribution +@REM MVNW_USERNAME/MVNW_PASSWORD - user and password for downloading maven +@REM MVNW_VERBOSE - true: enable verbose log; others: silence the output +@REM ---------------------------------------------------------------------------- + +@IF "%__MVNW_ARG0_NAME__%"=="" (SET __MVNW_ARG0_NAME__=%~nx0) +@SET __MVNW_CMD__= +@SET __MVNW_ERROR__= +@SET __MVNW_PSMODULEP_SAVE=%PSModulePath% +@SET PSModulePath= +@FOR /F "usebackq tokens=1* delims==" %%A IN (`powershell -noprofile "& {$scriptDir='%~dp0'; $script='%__MVNW_ARG0_NAME__%'; icm -ScriptBlock ([Scriptblock]::Create((Get-Content -Raw '%~f0'))) -NoNewScope}"`) DO @( + IF "%%A"=="MVN_CMD" (set __MVNW_CMD__=%%B) ELSE IF "%%B"=="" (echo %%A) ELSE (echo %%A=%%B) +) +@SET PSModulePath=%__MVNW_PSMODULEP_SAVE% +@SET __MVNW_PSMODULEP_SAVE= +@SET __MVNW_ARG0_NAME__= +@SET MVNW_USERNAME= +@SET MVNW_PASSWORD= +@IF NOT "%__MVNW_CMD__%"=="" (%__MVNW_CMD__% %*) +@echo Cannot start maven from wrapper >&2 && exit /b 1 +@GOTO :EOF +: end batch / begin powershell #> + +$ErrorActionPreference = "Stop" +if ($env:MVNW_VERBOSE -eq "true") { + $VerbosePreference = "Continue" +} + +# calculate distributionUrl, requires .mvn/wrapper/maven-wrapper.properties +$distributionUrl = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionUrl +if (!$distributionUrl) { + Write-Error "cannot read distributionUrl property in $scriptDir/.mvn/wrapper/maven-wrapper.properties" +} + +switch -wildcard -casesensitive ( $($distributionUrl -replace '^.*/','') ) { + "maven-mvnd-*" { + $USE_MVND = $true + $distributionUrl = $distributionUrl -replace '-bin\.[^.]*$',"-windows-amd64.zip" + $MVN_CMD = "mvnd.cmd" + break + } + default { + $USE_MVND = $false + $MVN_CMD = $script -replace '^mvnw','mvn' + break + } +} + +# apply MVNW_REPOURL and calculate MAVEN_HOME +# maven home pattern: ~/.m2/wrapper/dists/{apache-maven-,maven-mvnd--}/ +if ($env:MVNW_REPOURL) { + $MVNW_REPO_PATTERN = if ($USE_MVND) { "/org/apache/maven/" } else { "/maven/mvnd/" } + $distributionUrl = "$env:MVNW_REPOURL$MVNW_REPO_PATTERN$($distributionUrl -replace '^.*'+$MVNW_REPO_PATTERN,'')" +} +$distributionUrlName = $distributionUrl -replace '^.*/','' +$distributionUrlNameMain = $distributionUrlName -replace '\.[^.]*$','' -replace '-bin$','' +$MAVEN_HOME_PARENT = "$HOME/.m2/wrapper/dists/$distributionUrlNameMain" +if ($env:MAVEN_USER_HOME) { + $MAVEN_HOME_PARENT = "$env:MAVEN_USER_HOME/wrapper/dists/$distributionUrlNameMain" +} +$MAVEN_HOME_NAME = ([System.Security.Cryptography.MD5]::Create().ComputeHash([byte[]][char[]]$distributionUrl) | ForEach-Object {$_.ToString("x2")}) -join '' +$MAVEN_HOME = "$MAVEN_HOME_PARENT/$MAVEN_HOME_NAME" + +if (Test-Path -Path "$MAVEN_HOME" -PathType Container) { + Write-Verbose "found existing MAVEN_HOME at $MAVEN_HOME" + Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" + exit $? +} + +if (! $distributionUrlNameMain -or ($distributionUrlName -eq $distributionUrlNameMain)) { + Write-Error "distributionUrl is not valid, must end with *-bin.zip, but found $distributionUrl" +} + +# prepare tmp dir +$TMP_DOWNLOAD_DIR_HOLDER = New-TemporaryFile +$TMP_DOWNLOAD_DIR = New-Item -Itemtype Directory -Path "$TMP_DOWNLOAD_DIR_HOLDER.dir" +$TMP_DOWNLOAD_DIR_HOLDER.Delete() | Out-Null +trap { + if ($TMP_DOWNLOAD_DIR.Exists) { + try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } + catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } + } +} + +New-Item -Itemtype Directory -Path "$MAVEN_HOME_PARENT" -Force | Out-Null + +# Download and Install Apache Maven +Write-Verbose "Couldn't find MAVEN_HOME, downloading and installing it ..." +Write-Verbose "Downloading from: $distributionUrl" +Write-Verbose "Downloading to: $TMP_DOWNLOAD_DIR/$distributionUrlName" + +$webclient = New-Object System.Net.WebClient +if ($env:MVNW_USERNAME -and $env:MVNW_PASSWORD) { + $webclient.Credentials = New-Object System.Net.NetworkCredential($env:MVNW_USERNAME, $env:MVNW_PASSWORD) +} +[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12 +$webclient.DownloadFile($distributionUrl, "$TMP_DOWNLOAD_DIR/$distributionUrlName") | Out-Null + +# If specified, validate the SHA-256 sum of the Maven distribution zip file +$distributionSha256Sum = (Get-Content -Raw "$scriptDir/.mvn/wrapper/maven-wrapper.properties" | ConvertFrom-StringData).distributionSha256Sum +if ($distributionSha256Sum) { + if ($USE_MVND) { + Write-Error "Checksum validation is not supported for maven-mvnd. `nPlease disable validation by removing 'distributionSha256Sum' from your maven-wrapper.properties." + } + Import-Module $PSHOME\Modules\Microsoft.PowerShell.Utility -Function Get-FileHash + if ((Get-FileHash "$TMP_DOWNLOAD_DIR/$distributionUrlName" -Algorithm SHA256).Hash.ToLower() -ne $distributionSha256Sum) { + Write-Error "Error: Failed to validate Maven distribution SHA-256, your Maven distribution might be compromised. If you updated your Maven version, you need to update the specified distributionSha256Sum property." + } +} + +# unzip and move +Expand-Archive "$TMP_DOWNLOAD_DIR/$distributionUrlName" -DestinationPath "$TMP_DOWNLOAD_DIR" | Out-Null +Rename-Item -Path "$TMP_DOWNLOAD_DIR/$distributionUrlNameMain" -NewName $MAVEN_HOME_NAME | Out-Null +try { + Move-Item -Path "$TMP_DOWNLOAD_DIR/$MAVEN_HOME_NAME" -Destination $MAVEN_HOME_PARENT | Out-Null +} catch { + if (! (Test-Path -Path "$MAVEN_HOME" -PathType Container)) { + Write-Error "fail to move MAVEN_HOME" + } +} finally { + try { Remove-Item $TMP_DOWNLOAD_DIR -Recurse -Force | Out-Null } + catch { Write-Warning "Cannot remove $TMP_DOWNLOAD_DIR" } +} + +Write-Output "MVN_CMD=$MAVEN_HOME/bin/$MVN_CMD" diff --git a/spring-jasper-example/pom.xml b/spring-jasper-example/pom.xml new file mode 100644 index 0000000..91bd89d --- /dev/null +++ b/spring-jasper-example/pom.xml @@ -0,0 +1,63 @@ + + + + 4.0.0 + + + org.springframework.boot + spring-boot-starter-parent + 3.5.4 + + + + com.io + spring-jasper-example + 0.0.1-SNAPSHOT + spring-jasper-example + Demo project for Spring Boot + + + 21 + 3.5.4 + 7.0.3 + + + + + + org.springframework.boot + spring-boot-starter-web + ${spring.boot.version} + + + + net.sf.jasperreports + jasperreports + ${jasper.version} + + + + org.springframework.boot + spring-boot-starter-test + test + ${spring.boot.version} + + + + + + + + + + org.springframework.boot + spring-boot-maven-plugin + ${spring.boot.version} + + + + + + + diff --git a/spring-jasper-example/src/main/java/com/io/example/SpringJasperExampleApplication.java b/spring-jasper-example/src/main/java/com/io/example/SpringJasperExampleApplication.java new file mode 100644 index 0000000..9d65e18 --- /dev/null +++ b/spring-jasper-example/src/main/java/com/io/example/SpringJasperExampleApplication.java @@ -0,0 +1,13 @@ +package com.io.example; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +@SpringBootApplication +public class SpringJasperExampleApplication { + + public static void main(String[] args) { + SpringApplication.run(SpringJasperExampleApplication.class, args); + } + +} diff --git a/spring-jasper-example/src/main/resources/application-prd.yml b/spring-jasper-example/src/main/resources/application-prd.yml new file mode 100644 index 0000000..d08a5dd --- /dev/null +++ b/spring-jasper-example/src/main/resources/application-prd.yml @@ -0,0 +1,5 @@ + +spring: + + application: + name: spring-jasper-example-prd \ No newline at end of file diff --git a/spring-jasper-example/src/main/resources/application.yml b/spring-jasper-example/src/main/resources/application.yml new file mode 100644 index 0000000..bf94516 --- /dev/null +++ b/spring-jasper-example/src/main/resources/application.yml @@ -0,0 +1,5 @@ + +spring: + + application: + name: spring-jasper-example-dev \ No newline at end of file From 10c3506c74ef1d9384da5a6bc1e037d8c4ec026f Mon Sep 17 00:00:00 2001 From: igorcampos-dev Date: Wed, 13 Aug 2025 20:53:13 -0300 Subject: [PATCH 2/8] feat(readme): add Spring Boot + Jasper integration example to README --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7bc25cb..7d6277e 100644 --- a/README.md +++ b/README.md @@ -14,10 +14,11 @@ Each subdirectory in this repository represents a specific integration or featur Below you will find a summary table of each subproject. For more details, please refer to the individual README.md files. -| Name | Description | -|-----------------------------------------------|---------------------------------------------------------------------------------------------------------------| -| [Spring Boot + Kafka](./spring-kafka-example) | Demonstrates a basic integration between Spring Boot and Apache Kafka. | -| [Spring Boot + Keycloak](./spring-keycloak-example) | Demonstrates a basic integration between Spring Boot and Keycloak. | +| Name | Description | +|---------------------------------------------------------------------------|-----------------------------------------------------------------------------------| +| [Spring Boot + Jasper](./spring-jasper-example) | Demonstrates a basic integration between Spring Boot and Jasper. | +| [Spring Boot + Kafka](./spring-kafka-example) | Demonstrates a basic integration between Spring Boot and Apache Kafka. | +| [Spring Boot + Keycloak](./spring-keycloak-example) | Demonstrates a basic integration between Spring Boot and Keycloak. | | [Spring Boot + Grafana + Prometheus](./spring-prometheus-grafana-example) | Demonstrates a basic integration between Spring Boot With Grafana and Prometheus. | --- From c6649c91f8f8f53a550b461368622ab632d2b09b Mon Sep 17 00:00:00 2001 From: igorcampos-dev Date: Wed, 13 Aug 2025 20:58:33 -0300 Subject: [PATCH 3/8] feat(spring-japer-example): update project version to 1.0 --- spring-jasper-example/pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spring-jasper-example/pom.xml b/spring-jasper-example/pom.xml index 91bd89d..2297b43 100644 --- a/spring-jasper-example/pom.xml +++ b/spring-jasper-example/pom.xml @@ -13,7 +13,7 @@ com.io spring-jasper-example - 0.0.1-SNAPSHOT + 1.0 spring-jasper-example Demo project for Spring Boot From f2feb78564a46ae294c326c594aa488f5ba9fa44 Mon Sep 17 00:00:00 2001 From: igorcampos-dev Date: Wed, 13 Aug 2025 21:03:39 -0300 Subject: [PATCH 4/8] feat(spring-jasper-example): bump project version to 1.0.0 --- spring-jasper-example/pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/spring-jasper-example/pom.xml b/spring-jasper-example/pom.xml index 2297b43..9eaa58c 100644 --- a/spring-jasper-example/pom.xml +++ b/spring-jasper-example/pom.xml @@ -13,7 +13,7 @@ com.io spring-jasper-example - 1.0 + 1.0.0 spring-jasper-example Demo project for Spring Boot From afd5c784673dadd164f4c16ca9b58958c63ac61d Mon Sep 17 00:00:00 2001 From: igorcampos-dev Date: Wed, 13 Aug 2025 21:51:41 -0300 Subject: [PATCH 5/8] feat(banner/spring-jasper-example): add custom banner for Spring Jasper example project --- spring-jasper-example/src/main/resources/banner.txt | 8 ++++++++ 1 file changed, 8 insertions(+) create mode 100644 spring-jasper-example/src/main/resources/banner.txt diff --git a/spring-jasper-example/src/main/resources/banner.txt b/spring-jasper-example/src/main/resources/banner.txt new file mode 100644 index 0000000..52d94bb --- /dev/null +++ b/spring-jasper-example/src/main/resources/banner.txt @@ -0,0 +1,8 @@ + + ,---. ,--. ,--. +' .-' ,---. ,--.--.`--',--,--, ,---. ,-----. | | ,--,--. ,---. ,---. ,---. ,--.--. +`. `-. | .-. || .--',--.| \| .-. |'-----',--. | |' ,-. |( .-' | .-. || .-. :| .--' +.-' || '-' '| | | || || |' '-' ' | '-' /\ '-' |.-' `)| '-' '\ --.| | +`-----' | |-' `--' `--'`--''--'.`- / `-----' `--`--'`----' | |-' `----'`--' + `--' `---' `--' + SPRING-JASPER-EXAMPLE \ No newline at end of file From 9d32a9eb0fc3df8c90d2a27444d2ec4bc0155366 Mon Sep 17 00:00:00 2001 From: igorcampos-dev Date: Sat, 16 Aug 2025 00:07:26 -0300 Subject: [PATCH 6/8] feat(spring-jasper-example): rename application profiles for production and development --- spring-jasper-example/src/main/resources/application-dev.yml | 5 +++++ spring-jasper-example/src/main/resources/application-prd.yml | 5 ----- spring-jasper-example/src/main/resources/application.yml | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) create mode 100644 spring-jasper-example/src/main/resources/application-dev.yml delete mode 100644 spring-jasper-example/src/main/resources/application-prd.yml diff --git a/spring-jasper-example/src/main/resources/application-dev.yml b/spring-jasper-example/src/main/resources/application-dev.yml new file mode 100644 index 0000000..bf94516 --- /dev/null +++ b/spring-jasper-example/src/main/resources/application-dev.yml @@ -0,0 +1,5 @@ + +spring: + + application: + name: spring-jasper-example-dev \ No newline at end of file diff --git a/spring-jasper-example/src/main/resources/application-prd.yml b/spring-jasper-example/src/main/resources/application-prd.yml deleted file mode 100644 index d08a5dd..0000000 --- a/spring-jasper-example/src/main/resources/application-prd.yml +++ /dev/null @@ -1,5 +0,0 @@ - -spring: - - application: - name: spring-jasper-example-prd \ No newline at end of file diff --git a/spring-jasper-example/src/main/resources/application.yml b/spring-jasper-example/src/main/resources/application.yml index bf94516..d08a5dd 100644 --- a/spring-jasper-example/src/main/resources/application.yml +++ b/spring-jasper-example/src/main/resources/application.yml @@ -2,4 +2,4 @@ spring: application: - name: spring-jasper-example-dev \ No newline at end of file + name: spring-jasper-example-prd \ No newline at end of file From c2bb755261c63f032ded60f67c200b54e5e86a73 Mon Sep 17 00:00:00 2001 From: igorcampos-dev Date: Sat, 16 Aug 2025 23:59:40 -0300 Subject: [PATCH 7/8] feat(spring-jasper-example): add container name for app service in compose.yaml --- spring-jasper-example/compose.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/spring-jasper-example/compose.yaml b/spring-jasper-example/compose.yaml index 96a0477..c8ee2b0 100644 --- a/spring-jasper-example/compose.yaml +++ b/spring-jasper-example/compose.yaml @@ -1,6 +1,7 @@ services: app: + container_name: app build: context: . ports: From a52daba8866d929a3a4e9c9485884639d4419c0e Mon Sep 17 00:00:00 2001 From: igorcampos-dev Date: Sun, 17 Aug 2025 16:56:32 -0300 Subject: [PATCH 8/8] feat(spring-jasper-example): implement client report generation with JasperReports --- spring-jasper-example/Dockerfile | 2 +- spring-jasper-example/README.md | 23 +++++++ spring-jasper-example/compose.yaml | 5 +- spring-jasper-example/pom.xml | 67 ++++++++++++++++--- .../controller/ReportController.java | 28 ++++++++ .../io/example/clientList/dto/ClientDto.java | 16 +++++ .../clientList/service/ReportDevService.java | 49 ++++++++++++++ .../service/ReportLocalService.java | 39 +++++++++++ .../clientList/service/ReportService.java | 5 ++ .../resources/application-client-list-dev.yml | 7 ++ .../application-client-list-local.yml | 7 ++ .../src/main/resources/application-dev.yml | 5 -- .../src/main/resources/application.yml | 2 + .../main/resources/reports/client-list.jrxml | 36 ++++++++++ 14 files changed, 273 insertions(+), 18 deletions(-) create mode 100644 spring-jasper-example/src/main/java/com/io/example/clientList/controller/ReportController.java create mode 100644 spring-jasper-example/src/main/java/com/io/example/clientList/dto/ClientDto.java create mode 100644 spring-jasper-example/src/main/java/com/io/example/clientList/service/ReportDevService.java create mode 100644 spring-jasper-example/src/main/java/com/io/example/clientList/service/ReportLocalService.java create mode 100644 spring-jasper-example/src/main/java/com/io/example/clientList/service/ReportService.java create mode 100644 spring-jasper-example/src/main/resources/application-client-list-dev.yml create mode 100644 spring-jasper-example/src/main/resources/application-client-list-local.yml delete mode 100644 spring-jasper-example/src/main/resources/application-dev.yml create mode 100644 spring-jasper-example/src/main/resources/reports/client-list.jrxml diff --git a/spring-jasper-example/Dockerfile b/spring-jasper-example/Dockerfile index e10b2ee..7d5376f 100644 --- a/spring-jasper-example/Dockerfile +++ b/spring-jasper-example/Dockerfile @@ -42,6 +42,6 @@ COPY --from=extract build/target/extracted/spring-boot-loader/ ./ COPY --from=extract build/target/extracted/snapshot-dependencies/ ./ COPY --from=extract build/target/extracted/application/ ./ -EXPOSE 80 +EXPOSE 8082 ENTRYPOINT [ "java", "org.springframework.boot.loader.launch.JarLauncher" ] \ No newline at end of file diff --git a/spring-jasper-example/README.md b/spring-jasper-example/README.md index 9f6ac56..2956a49 100644 --- a/spring-jasper-example/README.md +++ b/spring-jasper-example/README.md @@ -1 +1,24 @@ # spring-jasper-example + +--- + +## Overview + +Basic Java Spring (Java 21) project demonstrating report generation with JasperReports. +Includes loading `.jasper` templates, populating them with mock data, and exporting to PDF via a REST endpoint. + +--- + +## Tech stack + +- Spring Boot +- Java 21 +- JasperReports + +--- + +## Profiles you can activate + +- **client-list-dev** – Used in Docker, in the future, it will use pre-compiled `.jasper` files instead of `.jrxml`. Activates the internal module that generates a simple client report. +- **client-list-local** – Used locally, activates the internal module that generates a simple client report and use `.jrxml`. + diff --git a/spring-jasper-example/compose.yaml b/spring-jasper-example/compose.yaml index c8ee2b0..b1f5ff4 100644 --- a/spring-jasper-example/compose.yaml +++ b/spring-jasper-example/compose.yaml @@ -5,6 +5,7 @@ services: build: context: . ports: - - "80:80" + - "8082:8082" environment: - SPRING_PROFILES_ACTIVE: prd \ No newline at end of file + SPRING_PROFILES_ACTIVE: client-list-dev + SERVER_PORT: 8082 \ No newline at end of file diff --git a/spring-jasper-example/pom.xml b/spring-jasper-example/pom.xml index 9eaa58c..22c2300 100644 --- a/spring-jasper-example/pom.xml +++ b/spring-jasper-example/pom.xml @@ -21,7 +21,8 @@ 21 3.5.4 7.0.3 - + 1.18.38 + @@ -35,8 +36,33 @@ net.sf.jasperreports jasperreports ${jasper.version} + + + commons-logging + commons-logging + + + + net.sf.jasperreports + jasperreports-pdf + ${jasper.version} + + + commons-logging + commons-logging + + + + + + org.projectlombok + lombok + true + ${lombok.version} + + org.springframework.boot spring-boot-starter-test @@ -46,18 +72,39 @@ - + + + - + + org.apache.maven.plugins + maven-compiler-plugin + + + + org.projectlombok + lombok + + + + - - org.springframework.boot - spring-boot-maven-plugin - ${spring.boot.version} - + + org.springframework.boot + spring-boot-maven-plugin + ${spring.boot.version} + + + + org.projectlombok + lombok + + + + - + - + diff --git a/spring-jasper-example/src/main/java/com/io/example/clientList/controller/ReportController.java b/spring-jasper-example/src/main/java/com/io/example/clientList/controller/ReportController.java new file mode 100644 index 0000000..494a9fb --- /dev/null +++ b/spring-jasper-example/src/main/java/com/io/example/clientList/controller/ReportController.java @@ -0,0 +1,28 @@ +package com.io.example.clientList.controller; + +import com.io.example.clientList.service.ReportService; +import lombok.RequiredArgsConstructor; +import org.springframework.context.annotation.Profile; +import org.springframework.http.HttpHeaders; +import org.springframework.http.MediaType; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.RestController; + +@RestController +@Profile({"client-list-dev", "client-list-local"}) +@RequiredArgsConstructor +public class ReportController { + + private final ReportService reportService; + + @GetMapping("/reports/clients") + public ResponseEntity getClientsReport() { + byte[] pdf = this.reportService.generateClientReport(); + return ResponseEntity.ok() + .header(HttpHeaders.CONTENT_DISPOSITION, "inline; filename=clients.pdf") + .contentType(MediaType.APPLICATION_PDF) + .body(pdf); + } + +} diff --git a/spring-jasper-example/src/main/java/com/io/example/clientList/dto/ClientDto.java b/spring-jasper-example/src/main/java/com/io/example/clientList/dto/ClientDto.java new file mode 100644 index 0000000..85fd766 --- /dev/null +++ b/spring-jasper-example/src/main/java/com/io/example/clientList/dto/ClientDto.java @@ -0,0 +1,16 @@ +package com.io.example.clientList.dto; + +import lombok.AllArgsConstructor; +import lombok.Data; +import lombok.NoArgsConstructor; + +@Data +@NoArgsConstructor +@AllArgsConstructor +public class ClientDto { + + private Integer id; + private String name; + private String country; + +} diff --git a/spring-jasper-example/src/main/java/com/io/example/clientList/service/ReportDevService.java b/spring-jasper-example/src/main/java/com/io/example/clientList/service/ReportDevService.java new file mode 100644 index 0000000..af9d4e5 --- /dev/null +++ b/spring-jasper-example/src/main/java/com/io/example/clientList/service/ReportDevService.java @@ -0,0 +1,49 @@ +package com.io.example.clientList.service; + +import com.io.example.clientList.dto.ClientDto; +import net.sf.jasperreports.engine.*; +import net.sf.jasperreports.engine.data.JRBeanCollectionDataSource; +import org.springframework.context.annotation.Profile; +import org.springframework.core.io.ClassPathResource; +import org.springframework.stereotype.Service; + +import java.io.InputStream; +import java.util.*; + +@Service +@Profile({"client-list-dev"}) +public class ReportDevService implements ReportService { + + private static final List clients = Arrays.asList( + new ClientDto(1, "Alice", "Brazil"), + new ClientDto(2, "Bob", "USA"), + new ClientDto(3, "Carlos", "Spain") + ); + + @Override + public byte[] generateClientReport() { + return this.exportReportToPdf(); + } + + /* + * TODO: In the future, this should be migrated to use: + * + * InputStream stream = new ClassPathResource("reports/client-list.jasper").getInputStream(); + * JasperReport jasperReport = (JasperReport) JRLoader.loadObject(stream); + * + * This approach is the recommended way in production environments. + */ + + private byte[] exportReportToPdf(){ + try { + InputStream stream = new ClassPathResource("reports/client-list.jrxml").getInputStream(); + JasperReport jasperReport = JasperCompileManager.compileReport(stream); + JRBeanCollectionDataSource dataSource = new JRBeanCollectionDataSource(clients); + JasperPrint jasperPrint = JasperFillManager.fillReport(jasperReport, new HashMap<>(), dataSource); + return JasperExportManager.exportReportToPdf(jasperPrint); + } catch (Exception e) { + throw new RuntimeException(e); + } + } + +} diff --git a/spring-jasper-example/src/main/java/com/io/example/clientList/service/ReportLocalService.java b/spring-jasper-example/src/main/java/com/io/example/clientList/service/ReportLocalService.java new file mode 100644 index 0000000..bf8b2ab --- /dev/null +++ b/spring-jasper-example/src/main/java/com/io/example/clientList/service/ReportLocalService.java @@ -0,0 +1,39 @@ +package com.io.example.clientList.service; + +import com.io.example.clientList.dto.ClientDto; +import net.sf.jasperreports.engine.*; +import net.sf.jasperreports.engine.data.JRBeanCollectionDataSource; +import org.springframework.context.annotation.Profile; +import org.springframework.core.io.ClassPathResource; +import org.springframework.stereotype.Service; +import java.io.InputStream; +import java.util.*; + +@Service +@Profile({"client-list-local"}) +public class ReportLocalService implements ReportService { + + private static final List clients = Arrays.asList( + new ClientDto(1, "Alice", "Brazil"), + new ClientDto(2, "Bob", "USA"), + new ClientDto(3, "Carlos", "Spain") + ); + + @Override + public byte[] generateClientReport() { + return this.exportReportToPdf(); + } + + private byte[] exportReportToPdf(){ + try { + InputStream stream = new ClassPathResource("reports/client-list.jrxml").getInputStream(); + JasperReport jasperReport = JasperCompileManager.compileReport(stream); + JRBeanCollectionDataSource dataSource = new JRBeanCollectionDataSource(clients); + JasperPrint jasperPrint = JasperFillManager.fillReport(jasperReport, new HashMap<>(), dataSource); + return JasperExportManager.exportReportToPdf(jasperPrint); + } catch (Exception e) { + throw new RuntimeException(e); + } + } + +} diff --git a/spring-jasper-example/src/main/java/com/io/example/clientList/service/ReportService.java b/spring-jasper-example/src/main/java/com/io/example/clientList/service/ReportService.java new file mode 100644 index 0000000..31ce34d --- /dev/null +++ b/spring-jasper-example/src/main/java/com/io/example/clientList/service/ReportService.java @@ -0,0 +1,5 @@ +package com.io.example.clientList.service; + +public interface ReportService { + byte[] generateClientReport(); +} diff --git a/spring-jasper-example/src/main/resources/application-client-list-dev.yml b/spring-jasper-example/src/main/resources/application-client-list-dev.yml new file mode 100644 index 0000000..39a2a00 --- /dev/null +++ b/spring-jasper-example/src/main/resources/application-client-list-dev.yml @@ -0,0 +1,7 @@ +server: + port: ${SERVER_PORT:8082} + +spring: + + application: + name: spring-jasper-example-client-list-dev \ No newline at end of file diff --git a/spring-jasper-example/src/main/resources/application-client-list-local.yml b/spring-jasper-example/src/main/resources/application-client-list-local.yml new file mode 100644 index 0000000..872bdd1 --- /dev/null +++ b/spring-jasper-example/src/main/resources/application-client-list-local.yml @@ -0,0 +1,7 @@ +server: + port: ${SERVER_PORT:8081} + +spring: + + application: + name: spring-jasper-exampleclient-list-local \ No newline at end of file diff --git a/spring-jasper-example/src/main/resources/application-dev.yml b/spring-jasper-example/src/main/resources/application-dev.yml deleted file mode 100644 index bf94516..0000000 --- a/spring-jasper-example/src/main/resources/application-dev.yml +++ /dev/null @@ -1,5 +0,0 @@ - -spring: - - application: - name: spring-jasper-example-dev \ No newline at end of file diff --git a/spring-jasper-example/src/main/resources/application.yml b/spring-jasper-example/src/main/resources/application.yml index d08a5dd..f72c387 100644 --- a/spring-jasper-example/src/main/resources/application.yml +++ b/spring-jasper-example/src/main/resources/application.yml @@ -1,3 +1,5 @@ +server: + port: ${SERVER_PORT:8080} spring: diff --git a/spring-jasper-example/src/main/resources/reports/client-list.jrxml b/spring-jasper-example/src/main/resources/reports/client-list.jrxml new file mode 100644 index 0000000..868cffb --- /dev/null +++ b/spring-jasper-example/src/main/resources/reports/client-list.jrxml @@ -0,0 +1,36 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +