[Open Source Project] JitPack에 내가 만든 Library & Framework 올리기

 

 

 

 

혼자 공부하는 자바:JAVA 8 & 11 지원/무료 동영상 강의 제공

 

Do it! 자바 프로그래밍 입문 : 개발 10년 강의 10년 명강사의 기초튼튼 코딩 밥상

 

Java의 정석:최신 Java 8.0 포함

"이 포스팅은 쿠팡 파트너스 활동의 일환으로, 이에 따른 일정액의 수수료를 제공받습니다."

 

🗂 목차

●[Open Source Project] JitPack에 내가 만든 Library & Framework 올리기 
●

 

 

🚀 나만의 Library & Framework 공유하기

    🔽 개요

        📦 소개

개발자에게 있어 내가 만든 코드를 누군가 사용한다는 것은 굉장히 설레는 일이고, 뿌듯한 일이 될 것이에요.
Exception을 해결해서 구동되는 모습을 보아도 너무 흥분되고, 좋지만 더 나아가 내가 만든 코드를 누군가가 쓴다는 것은 더욱 기분 좋은 일이 아닐까 생각되요.

주니하랑은 기깔나는 사람들 Side Project를 진행하면서 우리가 만들 수 있는 Library나, Framework를 만들어서 배포하자고 주장하였어요.

그렇게해서 누군가와 소통하면서 지속적으로 좋은 코드를 만들 수 있다면 게임보다 더 재밌는 게임이 될 것이라 생각해요.

이번 글에서는 Jitpack을 통해 Library를 만들어 올리는 방법에 대해 정리를 해보려 합니다.

JAVA와 Gradle Build Tool을 이용하고, Github을 통해서 Library를 배포해 보려해요.

참고로 maven central repository에 올리는 방법도 있는데, 너무 까다롭고 어려워서 좀 더 편하게 JitPack을 사용해 보려고 해요.

 

 

 

        📦 Project 준비

최초 주니하랑은 위와 같이 Project를 준비하여 주었어요.
Web 개발 Project가 아니기 때문에 위와 같이 Java를 이용하여 주었어요.

참고로 주니하랑은 GrupID를 github을 통해 배포할 것이고, 조직을 사용하고 있기 때문에 아래와 같이 설정해 주었어요.
io.github.{조직 혹은 계정 이름}

apply plugin: 'java'
apply plugin: 'maven-publish'

//plugins {
//    id 'java'
//}

group 'io.github.JunyHarang-Open-Source-project'
version '1.0-SNAPSHOT'

sourceCompatibility = 11
targetCompatibility = 11

repositories {
    mavenCentral()
}

dependencies {
    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.8.1'
    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.8.1'
    // https://mvnrepository.com/artifact/org.projectlombok/lombok
    compileOnly 'org.projectlombok:lombok:1.18.24'
    // https://mvnrepository.com/artifact/commons-codec/commons-codec
    implementation 'commons-codec:commons-codec:1.15'
    testImplementation 'org.assertj:assertj-core:3.21.0'
}

java {
    withSourcesJar()
    withJavadocJar()
}

publishing {
    publications {
        maven(MavenPublication) {
            from components.java
        }
    }
}

wrapper {
    gradleVersion = "7.5.1"
    distributionType = Wrapper.DistributionType.ALL
}

test {
    useJUnitPlatform()
}

728x90

Build.gradle 같은 경우 Jitpack 예제에 맞춰서 일부 변형을 해 주었어요.

 

 

    🔽  JitPack

        📦 준비하기

JitPack은 JVM Libary Deploy Platform으로 까다로운 인증, 설정없이 JitPack에 원하는 Build 결과물만 내놓을 수 있는 Project라면 Github 등 Repository 존재만으로 배포할 수 있게 해주고 있어요.

최초 작업하기에 앞 써 Project Directory 최상위 경로에 jitpack.yml이라는 Script를 만들고, 내부에 JDK Version을 명시해 주어야 해요.

jitpack.yml

JitPack은 기본적으로 Build를 jdk 1.8로 수행하기 때문에 이와 다른 Version을 사용한다면 예외가 발생하여 배포가 정상적으로 이뤄지지 않을 수 있기 때문이에요.

이제 Github에 Project를 준비해 두어야 해요.

주니하랑의 Project는 이 곳에서 만나볼 수 있도록 준비해 둘게요.

https://github.com/JunyHarang-Open-Source-project/Data-Aes-Secret

https://github.com/JunyHarang-Open-Source-project/Data-Aes-Secret

그런 뒤 위와 같이 Github Release를 수행해 줍니다.

반응형

그런 뒤 JitPack(https://jitpack.io)로 이동하여 해당 Project Repository 주소를 입력하고, Look up을 눌러줄게요.

그럼 위와 같이 Github에서 수행했던 Realese Version이 나오는걸 확인할 수 있어요.

조금 기다린 뒤 Get it Button 위와 같이 초록색으로 나오면 정상적으로 Build가 수행된 것이에요.

만약 실패했다면 Log 아래 문서 모양 Button이 빨간색이 되고, Status가 Report로 변하게 될 거에요.
해당 예제 Log 내용은 이 곳에서 확인할 수 있도록 준비해 두었어요.

 

위 과정을 수행한 뒤 아래에 나와있는 내용들에 대해 build.gradle에 입력을 해주면 외부 Project에서 사용할 수 있게 되요.

 

 

    🔽  확인하기

        📦 다른 Project에서 의존성 추가해 보기

build.gradle

최초 위와 같이 dependencies{} 위에 allprojects{} 내용을 넣어 주었어요.

그런 뒤 dependencies에 실제 추가할 의존성 내용을 추가해 줍니다.

dependencies {
		...
    // Data 암/복호화 의존성 추가
    implementation 'com.github.JunyHarang-Open-Source-project:Data-Aes-Secret:1.0.0b'
    	...
}

현재 위와 같이 Data 암호화 Logic에 대한 Class가 없는걸 확인할 수 있어요.

package com.giggalsspeople.itding.common.config.util;

import com.junyharang.datasecret.DataAesSecret;
import org.junit.jupiter.api.DisplayName;
import org.junit.jupiter.api.Test;

import static org.springframework.test.util.AssertionErrors.assertEquals;

class DataSecretTest {

    @Test
    @DisplayName("주요 데이터 AES 암/복호화 확인")
    void majorDataAES128Check() {
        String encryptionKeyValue = "좋은 서비스를 만들어요! 😀";
        String plainText = "우리 기깔나는 사람들은 할 수 있다!!";
        int[] algorithmLengthArray = {5, 128, 192, 256, 512 , 1024};

        String encryptionKey = DataAesSecret.base64Encoder(encryptionKeyValue);
        System.out.println("Base64 Encoding encryptionKeyValue : " + encryptionKey);

        for (int algorithmLength : algorithmLengthArray) {
            if (algorithmLength == 128) {
                System.out.println("AES-128 Mode로 암/복호화 실시");
            } else if (algorithmLength == 192) {
                System.out.println("AES-192 Mode로 암/복호화 실시");
            } else if (algorithmLength == 256) {
                System.out.println("AES-256 Mode로 암/복호화 실시");
            } else {
                System.out.println("AES-128 Mode로 암/복호화 실시");
            }

            String encryptionContent = DataAesSecret.aesSecret(algorithmLength, encryptionKey, plainText, 1);
            System.out.println("암호화된 내용(Encrypted Value) : " + encryptionContent);

            String decryptionBoardContent = DataAesSecret.aesSecret(algorithmLength, encryptionKey, encryptionContent, 2);
            System.out.println("복호화된 내용(Decrypted Value) : " + decryptionBoardContent);
            assertEquals("정상 처리 완료", plainText, decryptionBoardContent);
        }
    }

위와 같이 Test Code를 만들고 돌려 보면

정상적으로 실행되는 걸 확인할 수 있어요.


주니하랑이 만든 주요 Data AES 알고리즘을 이용한 암/복호화 Library가 필요하시다면 의존성을 추가해 주세요 😀

 

🧐 참고 자료

jitpack, github를 이용한 라이브러리 배포하기

 

혼자 공부하는 자바:JAVA 8 & 11 지원/무료 동영상 강의 제공

 

Do it! 자바 프로그래밍 입문 : 개발 10년 강의 10년 명강사의 기초튼튼 코딩 밥상

 

Java의 정석:최신 Java 8.0 포함

"이 포스팅은 쿠팡 파트너스 활동의 일환으로, 이에 따른 일정액의 수수료를 제공받습니다."