1탄에서는, OpenApi Generator 그게 뭔데, 어떻게 하는 건데! 를 알아보기 위한 테스트를 다루었는데요. 이번 2탄에서는, 실제 적용을 어떻게 할지, 적용이 가능할지를 알기 위한 세팅 및 테스트 작업을 다뤄보도록 할게요.

서론: Ktor, 이유

저희가 개발할 서비스는 우테코 크루들을 위한 공지&출결 앱 서비스 인데요. 다만, (1) 우테코 내에는 아직 ios 과정은 없어, 아이폰을 쓰는 크루들을 위한 앱 서비스는 부재하게 되어요. (물론 웹 서비스 사용이 가능할 예정이어요!) (2) 또한, kotlin multiplatform을 경험&시도 해보고자 하는 욕구가 있어요. (3) 현업 개발자가 아닌 학습을 하고 있는 크루로서, 짱짱 레아와 함께 개발할 수 있는 지금, 이것저것 해보기에 대한 두려움을 갖지 않기로 했습니다. (a.k.a. 낭만주도개발) 물론 러닝 커브에 대한 걱정이 많았지만, 앞으로 개발을 하며 경험해보기 힘들 수 있는 것들을 이번 기회에 도전해보면 좋겠다는 제이슨의 말씀이 많이 와닿았습니다. 뭉클,,감동,,

이러한 이유로, 저희는 kotlin multiplatform 활용에 대한 확장성을 열어두고, ktor를 적용하기로 결정하였습니다. (잘부탁해 산군ㅎㅎ)

Ktor 기본 세팅

공식문서를 보면, 다음과 같이 ktor를 지원함을 볼 수 있는데요. 결론부터 말씀드리면, 위의 문서는 업데이트가 더딘 것 같아요. 이유에 대해서는 후술하도록 할게요!

ktor 세팅은 다음과 같이 해줍니다.

    // build.gradle.kts (project)
    id("org.jetbrains.kotlin.plugin.serialization") version "1.6.21"

    // build.gradle.kts (app)
    plugins {
        ...
        id("kotlinx-serialization")
    }

    // ktor
    implementation("io.ktor:ktor-client-core:2.1.3")
    implementation("io.ktor:ktor-client-cio:2.1.3")
    implementation("io.ktor:ktor-client-content-negotiation:2.1.3")
    testImplementation("io.ktor:ktor-client-mock:2.1.3")
    // serialization
    implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.5.1")
    implementation("io.ktor:ktor-serialization-kotlinx-json:2.1.3") 

ktor client 시작하기 공식문서를 보면,

ktor-client-core is a core dependency that provides the main client functionality, while ktor-client-cio is a dependency for an engine processing network requests.

ktor-client-core는 ktor-client 기능들을 사용하기 위한 핵심 라이브러리고, ktor-client-cio는 네트워크 요청을 처리하는 엔진에 대한 종속성입니다. Ktor HTTP 클라이언트는 JVM, Android, JS, Native(iOS/desktop)과 같이 다른 플랫폼에서 사용될 수 있고, 플랫폼마다 네트워크 처리 요청을 위한 특정 engine이 필요할 수 있어요.

Content Negotiation은 client와 server 간의 media type을 중계해주고 (Accept, Content-Type Header 사용), 요청/응답 콘텐츠를 직렬화/역직렬화합니다.

JSON 직렬화/역직렬화를 위해 kotlinx.serialization 의존성도 추가해주었습니다.

code generate

지난 블로그에서 설명한 방식대로, 환경에 맞게 코드를 generate 합니다.

configOptions.set(
    mapOf(
        "library" to "jvm-ktor",
        "dateLibrary" to "java8",
        "omitGradleWrapper" to "true",
        "sourceFolder" to "src/main/java",
        "useCoroutines" to "true",
        "serializationLibrary" to "kotlinx_serialization"
    ),
)

"useCoroutines" to "true"를 하면 알아서 suspend가 붙은 함수들이 생성되고, "serializationLibrary" to "kotlinx_serialization"를 추가하면 kotlinx_serialization으로 직렬화/역직렬화 할 수 있도록 모델이 생성됩니다. 추가하지 않으면 기본으로 moshi를 사용하던데,

To serialize/deserialize JSON data, you can choose one of the following libraries: kotlinx.serialization, Gson, or Jackson.

공식문서를 보면 moshi를 지원하지 않으니 꼭 serializationLibrary를 설정해주세요! (저는 3시간 삽질햇슴니다..엉엉)

위 과정을 거쳐 코드를 생성하고, 더불어 함께 새롭게 생겨난 build.gradle을 확인해보시면,

ext.ktor_version = '2.1.3'

ktor_version을 2.1.3을 사용하고 있음이 보입니다. 이러한 이유로 app gradle에서도 ktor 버전을 1.6.7 -> 2.1.3 으로 올려주었습니다. 놀랍게도 이 버전을 맞춰주니 generate된 코드들 중 빨간 줄이 뜨던 것들이 싹 사라집니다!! (뿌듯)

다만, generate된 코드들 중 딱 한 가지 수정사항이 있었는데요.

// ApiClient.kt
private val clientConfig: (HttpClientConfig<*>) -> Unit by lazy 
    {
        it.install(ContentNegotiation) {
            json() // 요 한 줄 추가 !!
        }
        httpClientConfig?.invoke(it)
    }
}

HttpClient 인스턴스를 관리하는 ApiClient 클래스가 생성되었는데요. (마치 Retrofit 인스턴스 - Retrofit.Builder 클래스가 떠오릅니다)

공식문서에 따르면, 이는 Json serializer를 등록하기 위한 코드입니다. 즉, 나 앱에서 Json 형태로 통신할거야 ~~ 라고 등록하는 겁니다!

이 코드가 없다면,

No transformation found: class io.ktor.utils.io.ByteBufferChannel -> class model.{ClassName}

위의 오류가 발생합니다.

(2023/10/24 update) 다만, open api generator의 특성상, api에 수정사항이 생길 때마다 코드를 새롭게 generate 해야 합니다. 그러므로 최대한 코드에 수정을 하지 않는 것이 좋은데요. kotlinx-serialization이 아닌 gson을 사용하면 해당 코드 위치에 gson()이 굳이 추가하지 않아도 작성되어 있습니다. 번거로움이 싫다면 gson을 사용하시길,,, (이렇게 백로그는 계속 추가되는데...)

작동 테스트

generate된 코드들이 잘 작동하는지, 이거이거 쓸만한건지~ 를 알기 위해 테스트 코드를 kotest로 하려고 했지만 익숙하지 않아 힘들어서 우선 JUnit으로 작성해보았는데요 !

@Test
fun codegenTest() = runTest {
    val api = DefaultApi(
        MOCK_SERVER_URL, null, null
    )
    val response = api.resourceIdGet(1)
    val actual = response.body()
    val expected = ResourceIdGet200Response(1, "Example Resource")
    assertEquals(expected, actual)
}

sample api를 만들고, postman으로 mock server를 만들어 테스트를 진행했습니다. (mock server 만드는 과정은 이 링크에!)

이미 코드들이 만들어져 있다보니, 사실상 사용할 것은 Api/DefaultApi, model/ResourceIdGet200Response 이 두 클래스 뿐이었어요.

DefaultApi에는 URL만 mock server url을 넣어주고, 나머지는 null로 두어 기본 default로 생성되도록 했습니다. 이후 api를 호출하고, response의 body를 가져와 예상값(mock server example)과 비교해주었어요.

결과는? 짜잔! 테스트가 통과했습니다. 👏👏

급 마무리

그래서 후기는.. 생각보다 쓸만할지도? 입니다. 우여곡절은 좀 있었지만, 점점 이거 괜찮은데 쓸만하겠는데? 생각이 들어요. 물론, api가 복잡해지고, 로그인 기능이 붙는다면 어떨지는 앞으로 차차 공부고민공부고민을 해보아야겠습니다 🤔

참고 문헌

중간중간 링크한 공식문서 외,,

Ktor Client&Engine https://ktor.io/docs/eap/http-client-engines.html https://essie-cho.com/kotlin-4/ https://velog.io/@shins/Kotlin-HTTP-Client-ktor-client Content negotiation and serialization https://ktor.io/docs/serialization-client.html Configure a serializer https://jyami.tistory.com/150 Ktor request https://essie-cho.tistory.com/36 Ktor test https://ktor.io/docs/http-client-testing.html Ktor 간단 설명 https://ktor.io/docs/http-client-testing.html#share-config

api

오늘의 실습을 위해 간단한 api를 만들어보았어요. 아주아주 단순한 @GET 하나, @DELETE 하나랍니다.

GET /resource/{id}

Request

{
    "id": 1
}

Respond

200 OK
{
    "id": 1,
    "name": "Example Resource"
}

DELETE /resource/{id}

Request

{
    "id": 1,
}

Response

204 No Content

아주 간단하죠? 이걸로 Mock Server를 만들어보도록 할게요!

MockServer 만들기

API 명세가 있으신 여러분, Postman을 켜세요! Workspace에 들어가면 다음과 같이 보일 텐데요. 여기서 Mock Servers를 클릭해서 Create Mock Server 클릭 ! 본격적으로 MockServer를 만들어봅시다. (만약 Mock Servers가 보이지 않는다면 하단 버튼(초록 네모)을 눌러보면 보입니다!)

다음과 같이 Mock Server에 들어갈 Request들의 정보들을 적어준 후,

Mock Server 세팅을 해주면 끝 ! Create Mock Server를 해줍시다 !

보너스 팁

💡 Save the mock server URL as an new environment variable

이 부분을 체크해주면, 생성한 mock server의 긴 url을 postman 내의 환경변수로 저장해주어요. 짜잔 url이라는 이름으로 변수가 만들어졌네요! 이 변수는 {{url}} 와 같은 형태로 사용이 가능합니다.

Example 만들기

Mock Server를 만든 뒤, 왼쪽 메뉴 중 Collections를 눌러보세요.

다음과 같이 Collection이 만들어져 있답니다 (짝짝) api가 만들어져있고, e.g.가 붙어있는 부분이 해당 api의 예시입니다.

Params, Authorization, Headers 등의 조건들을 다르게 하여 예시를 계속 추가할 수 있어요.
본격적으로 example을 만들기 위해, 우선 e.g.가 붙어있는 예제를 편집해볼게요.

상단의 Params, Headers, Body에는 Request에 관한 정보, 하단의 Body, Headers에는 Response에 관한 정보를 적어줘요. (저는 하단의 Body에 Json 형태로 받을 응답 예시를 적어주었어요!)

Try를 눌러 API를 호출했을 때 원하는 응답값이 잘 나온다면, 잊지 말고 변경 내역을 Save 해주세요 :)

저장을 하고 Mock Server의 View Collection Docs를 눌러보면, 해당 Example이 추가된 Mock Server 문서를 확인해볼 수 있어요.

Example 추가

만약, 새로운 조건 혹은 새로운 응답값, 또는 실패의 경우에 대해서도 example을 추가하고 싶다면, Add example을 해주면 됩니다. (간단하죵!?)

Mock Server Test

만들어진 Mock Server를 이용해서, Android 테스트에 적용해볼게요!

// HttpClient ( Retrofit2라면 Retrofit.Builder() )
val api = DefaultApi(
    // BaseUrl에 Mock Server Url 전달
    MOCK_SERVER_URL, null, null
)
// api 호출
val response = api.resourceIdGet(1)

val actual = response.body()
val expected = ResponseModel(1, "Example Resource")
assertEquals(expected, actual)

저는 Ktor를 활용해 API를 테스트해보았는데요! (제 이전 게시글을 보셨다면.. 눈치채셨을 수 있지만.. 호출하는 함수들이 code generator를 활용해 만들어진 코드들이므로.. 각 함수의 내부 코드는 저도 이해하지 못해서.. 공개하지 않을게욥... ㅠ_ㅠ)

여러분의 RetrofitBuilder, 혹은 HttpClient 등 서버 통신을 위한 클래스를 만들 때, BaseUrl에 mock server URL을 넘겨주면 Mock server와 통신이 가능해집니다.

.. 끗 !

참고 자료

https://devvkkid.tistory.com/219#toc-%E2%9C%8D%EF%B8%8F%20Mock%20Server%20%EB%A7%8C%EB%93%A4%EA%B8%B0 https://velog.io/@whytili/Postman-Mock-Server https://velog.io/@jeongminji4490/Android-Postman%EC%9C%BC%EB%A1%9C-Mock-Server-%EB%A7%8C%EB%93%A4%EC%96%B4%EC%84%9C-API-%ED%85%8C%EC%8A%A4%ED%8A%B8%ED%95%98%EA%B8%B0

우테코 내의 플랫폼 근로 활동을 하며, code generator을 활용하자는 의견이 나왔습니다. 그에 따라, Android에서 어떻게 시작하고 활용할 수 있을지, 사용하기에 적절한지를 알아보기 위해 다음과 같은 실습을 진행했어요!

연습한 코드 저장소: 링크

OpenApi Generator 공식문서에서 제공하는 실습용 petstore.yaml을 이용하였으며,
Android Studio Giraffe | 2022.3.1 에서 진행하였습니다.

안드로이드에서 OpenApi Generator 시작하기

1. openapi-generator-cli 설치하기

• (맥 기준) 터미널에서 brew install openapi-generator 을 실행해줍니다.

2. 안드로이드 프로젝트 및 gradle 설정하기

서버 개발자로부터 받은 api .yaml 파일을 프로젝트 내의 경로에 넣어줍니다.

이후, gradle을 다음과 같이 설정해주세요.

// build.gradle.kts (project 모듈)
plugins {
    ...
    id("org.openapi.generator") version "7.0.1" apply true
}

buildscript {
    repositories {
        maven(url = "https://repo1.maven.org/maven2")
    }
}

tasks.register(
    "generateClient",
    org.openapitools.generator.gradle.plugin.tasks.GenerateTask::class,
) {
    generatorName.set("kotlin")
    // .yaml 파일이 위치하는 경로
    inputSpec.set("$rootDir/specs/petstore-v3.0.yaml")
    // generate된 코드가 위치할 경로 
    outputDir.set("$rootDir/network")
    // genertate된 코드가 가질 상위 경로
    packageName.set("com.example.network")
    apiPackage.set("com.example.network.api")
    modelPackage.set("com.example.network.model")
    invokerPackage.set("com.example.network.invoker")
    // 설정하기
    // 프로젝트 설정에 맞는 library 선택 (하단 링크>공식문서 참고)
    configOptions.set(
        mapOf(
            "library" to "jvm-retrofit2",
            "dateLibrary" to "java8",
            "omitGradleWrapper" to "true",
            "sourceFolder" to "src/main/java",
            "useCoroutines" to "true",
        ),
    )
}

(이 링크에서 library를 참고하세요!)

4. run generateClient

gradle>Tasks>other>generateClient 를 실행해주세요.

4. 생성된 코드 모듈 분리하기

다만, 아직 모듈화가 되지 않은 상태로 존재하는데요. 방법은 간단합니다! settings.gradle.kts에 include(":network") 를 추가해주세요.

5. build 오류 해결

위의 과정을 거친 후 build를 하면, network 모듈의 gradle에서 오류가 발생하는데요. 사실 위의 코드를 지워주는 것으로 해결이 됩..니다. (이유를 찾아봐도 모르겠네요 ㅠㅠ 아시는 분 계시다면 공유 부탁드려요..!) (2023/10/24 update)

// setting.gradle.kts
repositoriesMode.set(RepositoriesMode.PREFER_SETTINGS)

repositoriesMode는 다음과 같이 세 종류가 있는데요, FAIL_ON_PROJECT_REPOS (default) PREFER_PROJECT PREFER_SETTINGS 이 중에서 PREFER_SETTINGS로 설정해주면 오류가 발생하지 않습니다.

위의 5단계를 거치면, 아주 간단하게 api 명세에 맞추어 코드들이 생성되고 app에서 바로 그 코드를 사용할 수 있습니다 :) (짝짝)

// 요로코롬 말이죠 !
class MainActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        val pet = Pet(
            "jiny",
            listOf("https://get.pxhere.com/photo/nature-grass-flower-wildlife-kitten-cat-mammal-fauna-close-up-whiskers-vertebrate-domestic-cat-macro-photography-young-cat-red-mackerel-tabby-red-cat-cat-baby-wild-cat-small-to-medium-sized-cats-cat-like-mammal-634099.jpg"),
        )
        ApiClient().createService(PetApi::class.java).addPet(pet).enqueue(object : Callback<Pet> {
            override fun onResponse(call: Call<Pet>, response: Response<Pet>) {
                Log.d("ssuu", "onResponse: ${response.body()}")
            }

            override fun onFailure(call: Call<Pet>, t: Throwable) {
                Log.d("ssuu", "onFailure: ${t.message}")
            }
        })
    }
}

고려할 점 & 아쉬운 점

자동으로 생성된 코드들은 정말 편리하게 느껴지고 참으로 신기하죠! 다만, 바로 사용하기엔 아쉬운 점들이 보이고 많은 비용이 들 것으로 예상되는데요. (공부가 더 필요하다는 얘기,,,)

코드를 처음 생성하고 빌드를 하면, 다음과 같은 오류가 발생했어요. org.apache.oltu.oauth2.common.Xxxx org.apache.oltu.oauth2.client.Xxxx 위의 두 패키지로부터의 클래스가 중복된다는 오류가 발생합니다.
network gradle에서 implementation "org.apache.oltu.oauth2:org.apache.oltu.oauth2.client:1.0.2" 를 주석처리해주면, 위의 문제는 해결할 수 있습니다. 다만, 위의 라이브러리를 사용하는 부분에서는 당연히 오류가 발생하겠죠 :)
이번 실습을 진행할 때는, 위의 오류와 관련된 코드들을 주석처리하고 진행하고, 기본적인 기능들이 수행되는지만 볼 수 있도록 테스트를 했어요. 하지만 이러한 오류들을 모두 해결하고 코드를 수정하기에는 많은 비용이 들 것 같아요.

💡 또는 gradle에서 task를 이용하여 필요없는 파일들은 생성되지 않도록 하는 방법도 추가적으로 찾아봐야겠어요! (api, model 파일만 생성할 수 있어도...!?)

또한, 코드들에 수많은 주석이 있고 깔끔하지 못한 모습이에요. 코드 제너레이터 기능을 통하여 api service, model (data class)도 만들어지고, 위에서 언급한 oauth 관련 코드들과 수많은 Adapter를 포함한 infrastructure 코드도 함께 만들어집니다.
다만, 코드 내에 많은 주석들이 포함되어 있고, 가독성이 좋지 못해요. api 명세가 수정되는 경우, 다시 generate하는 것도, 파일을 직접 수정하는 것도 번거로울 것으로 보여요.

결론

허둥지둥 결론을 내려보자면, code generator는 굉장히 편리하게 느껴지는 기능입니다. 다만, 아직 실제로 사용하기에는 오류 사항들도 있고 안정적이지 못한 것 같아요. 기능들이 많이 보완되고, 추가적인 학습을 통해 편리한 사용법을 찾게 된다면 더없이 편리한 기능이 될 것 같네요 ! :)

이번 근로 활동에서는, RDD (낭만 주도 설계) 를 할 예정이므로 (^^) code generator + ktor를 사용해볼 계획입니다. 그럼,, 다음 시리즈를 기대해주세요. 뿅,,

참고 자료

https://docs.gradle.org/current/javadoc/org/gradle/api/initialization/resolve/RepositoriesMode.html https://jaeryo2357.tistory.com/110

• 형태

    class className <generic data type> (properties...)
    val instanceName = class<generic data type>(parameters)

• 예시

  class Question<T>(
      val questionText: String,
       val answer: T,
       val difficulty: String
  )
  
  fun main() {
        val question1 = Question<String>("Quoth the raven ___", "nevermore", "medium")
        val question2 = Question<Boolean>("The sky is green. True or false", false, "easy")
        val question3 = Question<Int>("How many days are there between full moons?", 28, "hard")
  }

Enum Classes

• 가능한 값 집합이 제한되어 있는 유형

• 언제 필요한가? -- 만약 위의 예시의 difficulty가 easy, medium, hard로 정의되어 있다면,

  • 실수로 값을 잘못 입력할 경우 버그가 발생
  • medium을 average로 이름을 바꿀 경우 모두 업데이트 필요함
  • 다른 문자열을 사용하는 실수를 방지할 방법이 없음
  • difficulty가 더 추가될 경우 코드 관리가 어려워짐

• 형태

  enum class className(
      CASE1,   
      CASE2
  )

  ,로 구분하고, 상수 이름을 모두 대문자로 표기한다.

  className.caseName : . 연산자를 사용하여 참조한다.

• 예시

  enum class Difficulty {
    EASY, MEDIUM, HARD
  }
  
  class Question<T>(
    val questionText: String,
    val answer: T,
    val difficulty: Difficulty
  )
  
  val question1 = Question<String>("Quoth the raven ___", "nevermore", Difficulty.MEDIUM)
  val question2 = Question<Boolean>("The sky is green. True or false", false, Difficulty.EASY)
  val question3 = Question<Int>("How many days are there between full moons?", 28, Difficulty.HARD) 
  

Data Classes

• 위의 Question class 처럼, 데이터만 포함하고 메서드가 없는 경우 => data class로 정의 가능
• data class로 정의하면 일부 메서드가 자동으로 구현됨
  • equals(), hashCode(), toString(), componentN(), copy() 등
• 형태 data class className()
• 특징
  • 생성자에 매개변수 하나 이상 필요 (val or var 표시)
  • abstract, open, sealed, inner 불가능

Singleton, Companion objects

• 클래스에 인스턴스가 하나만 포함되기를 바라는 경우 => 해당 클래스의 인스턴스를 하나만 인스턴스화

싱글톤 객체

• 형태

  object objectName {}
  objectName.propertyName : `.` 연산자를 사용하여 참조한다.

• 특징

  • 생성자가 포함 X
  • 모든 속성이 { } 안에 정의되고 초기값이 부여된다.

• 예시

  object StudentProgress {
    var total: Int = 10
    var answered: Int = 3
  }
  
  fun main() {
    ...
    println("${StudentProgress.answered} of ${StudentProgress.total} answered.")
  }

Companion 객체

• 특징
  • 컴패니언 객체를 사용하여 다른 클래스 내에서 싱글톤 객체를 정의할 수 있다.
  • 클래스 내에서 속성과 메서드에 엑세스할 수 있어 문법이 간결해진다.

Extend properties and functions

• 예시 16.dp

• 해당 데이터 유형의 일부인 것처럼 .으로 액세스할 수 있는 속성과 메서드를 추가한다.

• 형태

  val typeName.propertyName: dataType
      property getter
  
  fun typeName.functionName(parameters): returnType { }

• 예시

  class Quiz {
    val question1 = Question<String>("Quoth the raven ___", "nevermore", Difficulty.MEDIUM)
    val question2 = Question<Boolean>("The sky is green. True or false", false, Difficulty.EASY)
    val question3 = Question<Int>("How many days are there between full moons?", 28, Difficulty.HARD)
  
    companion object StudentProgress {
        var total: Int = 10
        var answered: Int = 3
    }
  }
  
  val Quiz.StudentProgress.progressText: String
    get() = "${answered} of ${total} answered"
  
  

fun main() { println(Quiz.progressText) }

# Scope functions
  to access class properties and methods
  ## let() => 긴 객체 이름 바꾸기
  ``` kotlin
fun printQuiz() {
    question1.let {
        println(it.questionText)
        println(it.answer)
        println(it.difficulty)
    }
  }

apply() => 변수 없이 객체의 메서드 호출

  Quiz().apply {
    printQuiz()
}

다음과 같이 LottoNumber 리스트를 프로퍼티로 가지고 있는 Lotto 클래스가 있다.

참고로 LottoNumber 객체는 로또 범위 내의 숫자들을 미리 인스턴스화 해두었고 팩토리 함수를 통해 이를 리턴하는 형태이다.

이 경우, Lotto 객체를 생성하려면 다음과 같이 코드가 작성된다.

val lotto: Lotto = Lotto(listOf(1,2,3,4,5,6).map { LottoNumber.create(it) })

매번 생성할 때마다 다음과 같이 코드를 작성한다면 이는 일반 코드 뿐만 아니라 테스트 코드에서도 엄청난 가독성 방해(!?!)가 일어나게 될 것이고, 좀 더 간단하게 바꿔주고 싶은 강한 욕구가 든다.

constructor(numbers: List<Int>) : this(numbers.map { LottoNumber.create(it) })

이를 해결하기 위해 위와 같이 부생성자를 만들게 된다면 어떻게 될까?

Platform declaration clash: The following declarations have the same JVM signature ((Ljava/util/List;)V): constructor Lotto(numbers: List) defined in lotto.model.Lotto constructor Lotto(lotto: List) defined in lotto.model.Lotto

그렇다.. 다음과 같은 오류를 마주하게 된다. :(
이 오류가 무슨 의미냐면, List< Int >와 List< LottoNumber >가 같은 JVM signature를 갖고있다는 의미다. 즉, 이 시그니처가 동일하기 때문에 코틀린 코드가 바이트코드로 변경될 때 오류가 발생하는 것이다.

이는 JVM compiler가 파라미터 타입으로 함수 또는 생성자를 구분할 때 generic type은 구분하지 못하기 때문이다. List< Int >, List< String >, List< LottoNumber > 까지 <> 안에 무엇이 들어와도 에러가 발생한다.

이와 같이 JVM signature 오류가 발생한 경우, 보통 함수 앞에 @JvmName를 사용함으로써 해결할 수 있다. @JvmName은 JVM signature를 변경할 때 사용하는 annotation이다.

// 예시
@JvmName("callFromString")
fun call(a: List<String> {}
@JvmName("callFromInt")
fun call(a: List<Int>) {}

하지만 @JvmName은 생성자에서는 사용할 수 없다. 이 경우, 이를 해결하기 위한 방법은 무엇이 있을까 ???

vararg

constructor(vararg numbers: Int): this(numbers.map { LottoNumber.create(it) })

list< Int > 대신 가변인자 vararg 를 사용할 수 있다. 생성할 때 int array를 넘기면 되는데, 이 때 배열 앞에 * 표시를 붙여주어야 한다.

팩토리 함수

companion object {
    fun create(lotto: List<Int>) = Lotto(lotto.map { LottoNumber.create(it) }.sortedBy { it.toInt() })
}

companion object 객체를 활용하여 팩토리 함수를 정의한다.

Dummy Implicit

constructor(
    numbers: List<Int>,
    @Suppress("UNUSED_PARAMETER") dummyImplicit: Any? = null
): this(numbers.map { LottoNumber.create(it) })

사용하지 않는 매개변수를 하나 추가하여 다른 시그니처가 생성되도록 한다.

더 많은 방법이 있을 수도 있겠지만 우선 위의 3가지 방법을 공부해보았다. 물론 무엇이 더 옳은지 나쁜지 정답은 없기에, 상황에 맞게 편한 방법으로 대처하면 될 것 같다 :)

참고 || 참고 할 만한 자료 링크 Kotlin annotation 정리 팩토리 함수

1차 심사 합격

바야흐로 두 달 전.. 그렇다.. 이 메일을 받았다. 이 날 전공 기말고사 시험이 3시 시작이었는데, 정확히 3시에 이 메일을 받아서 !?!? 아 잠깐만 - 하면서 시험을 봤던 기억이 난다. ( 다행히 시험은 무사히 마쳤다. A+ 히히 ~ :> )

사실 프리코스가 끝나고 나서 밀린 과제 및 졸업 준비, 취준, 그리고 Compose Camp 까지 하느라 바빠서 프리코스를 회고하고 복습하는 시간은 현저히 적었기 때문에 기쁜 마음 반, 두려운 마음 반이 들었다. 게다가 최종 코딩테스트 날짜와 다른 전공 기말고사 시험이 완전히 겹쳤는데, 시험에 응시하지 않으면 F라고 하셔서 졸업을 앞둔 나는 불안한 마음이 컸다.

(누가 봐도 교수님st) 다행히도 교수님께서 사정을 봐주셔서 다행히 F는 면하게 되었고, 최종 코딩테스트에 참여하게 되었다 !!!! 교수님 감사합니다 (꾸벅)

최종 코딩 테스트

최종 코딩 테스트는 몽촌토성역에 있는 우아한형제들 큰집에서 응시했다. 이 날, 지하철 연착으로 놓치고 뒤에 갈아타는 열차까지 영향이 가서 또 놓치면서 아슬아슬하게 도착했다... 10분 일찍 출발이 아니라 20분 일찍 출발했어야 하나보다. 😂

무사히 도착하고 건물에 들어서자, 생수 한 병과 배민문방구 굿즈를 나눠주셨다!

그리고 코딩테스트를 진행했는데, 인터넷 사용도 되고, 이어폰도 써도 되고, 간식도 엄청 많이 준비되어 있어서 다 먹어도 된다...! 주변 사람들에게 방해가 되지 않는 선에서는 꽤나 관대했던 것 같다. 심지어 5시간이라는 긴 시간의 테스트기 때문에, 중간에 쉬는 시간도 강제로(!!) 주셨다. (모두들 노트북 덮고, 쉬세요!)

이렇게 자유로운 분위기의 코딩 테스트는 처음이라 무척 놀랐고, 엄청나게 긴장되는 테스트 속에서 조금이나마 마음이 편하게 시험에 임할 수 있었던 것 같다. 그리고 이런 배려와 자유로움이, 우테코에 더 가고 싶게 만들어주기도 했다.

최종 코딩테스트는 '점심 메뉴 추천' 만들기였다. (레포는 여기) 난이도는 기존 프리코스 과제들과 크게 다르지 않았다. 5시간 내에 할 수 있을까 걱정을 많이 했었는데, 다행히 5시간 꽉 채워서 무사히 구현해낼 수 있었다.

이 말만 믿고 사실, 그래 일단 해보자, 자신감을 얻고 진행했던 것 같다. ㅋㅋㅋ 당연히 읽기 좋은, 잘 짜여진 코드를 작성해야할 것 같았고, 실제로 시간적 제한이 있는 상황에서는 구현을 먼저 하는게 좋은지, 시간이 걸리더라도 요구사항에 맞춰서 예쁘게(?) 코드를 작성해야 할지 궁금증이 있었는데, 이 메일로 어느 정도 궁금증이 해소되었다...!

그래서 나는 처음 단계에서는 우선 구현을 열심히 했고, 구현을 다 한 뒤에 클래스 분리를 진행하고, 리팩토링을 진행했다.

최종 합격

코딩테스트가 끝나고 일주일간 매일 매일 후회와 기대를 반복하며 살았던 것 같다. 쉬는게 쉬는게 아니었다구요...! 😂 다행히 이 즈음에 아주 간단한 프로젝트 거리가 하나 생겨서 일부러 더 바쁘게 지내면서 잊고 지내려고 했다. 하하 크리스마스에도 코딩했습니다!!!!

그 자리에서 옴마낰!!!!! 했다. 내가 붙다니 내가 붙다니 !!!!! 2022년 중 가장 행복한 순간이었던 것 같다. 연말 선물같은 느낌 🥰

사실 1월에 해외에 있는 가족들을 만나러 가기로 했는데, 정말 가도 될까, 내가 이럴 때가 맞나, 불안한 마음도 크고 마음이 많이 싱숭생숭 했는데 2월부터 긴 여정을 시작하게 되니 이제 그 전까지 충분히 휴식을 취하고 오자 - 하는, 그런 편안한 마음을 갖고 떠나게 되었다 :)

그러고서 닉네임도 정하고, 사진도 보내고, (중국이라 구글폼 작성 안돼서 당황x10000했지만 다행히 보냈다. 휴 ~) 두근두근 개강일만을 기다리며 앞으로 같은 목표를 가진 좋은 사람들을 만나 열심히 해보아야지 다짐했고, 지금도 그 다짐을 다시금 상기시키며 열심히 살아본다. (뿌듯.. 이제 마저 코딩해야지)

FCM은, Firebase Cloud Messaging 의 약자입니다. 그렇다면 Firebase Cloud Messaging이 뭐냐구요?

• 무료로 메시지를 안정적으로 전송할 수 있는 교차 플랫폼 메시징 솔루션
• 사용자에게 개별적으로, 혹은 그룹을 지어 메시지를 전송 가능하다.

이게 무엇인지, 이게 무슨 말인지를 더 이해하기 위해 FCM 메시지가 어떤 식으로 작동되는 지를 보도록 하겠습니다.

1. 사용자가 모바일 기기에 앱을 설치하고 최초 실행 시에, 토큰을 얻기 위해 클라우드 서버에 토큰 요청을 보내고 이를 획득합니다.
2. 획득한 토큰을 서버로 전송하여 DB에 토큰값을 저장합니다. 즉, 토큰은 서버가 클라우드에 메시지 전송을 요청할 때 어디로 메시지를 보낼 것인지를 구분하기 위해 쓰이는 값입니다.
3. 서버에서 클라우드로 토큰과 메시지 데이터를 보내어 메시지 전송을 요청합니다.
4. 클라우드는 요청받은 메시지를 토큰에 해당하는 단말기로 전송합니다.
5. 앱이 실행중이 아니어도 리스너를 통해 메시지를 수신할 수 있습니다.

Why FCM?

FCM을 사용하는 이유, 즉 FCM의 이점들은 다음과 같이 있어요.

• FCM은 교차 플랫폼 메시징 솔루션입니다. 즉, Android, iOS 등의 플랫폼에 종속되지 않고 메시지를 전송할 수 있습니다.
• 실시간 메시지를 받기 위해 계속 접속 상태를 유지하다 보면 배터리와 네트워크의 사용 과다 등으로 인해 문제가 발생할 수 있습니다. 그러나 중간에 클라우드 메시지 서버를 둠으로써, 낮은 배터리와 네트워크 사용만으로 메시지의 실시간 송수신 처리가 가능합니다.
  

이 이후부터의 내용은 Android 기준입니다!

Start FCM

처음 접속

• FCM Console에 접속 -> 앱 추가 선택 -> Android 선택

• 패키지 이름, 앱 이름, SHA-1키를 입력

  how to get SHA-1

  SHA-1 키를 받는 방법은 다음과 같아요. (버전: Android Studio Dolphin 2021.3.1)

• 오른쪽 Gradle을 선택하고 (빨간 네모), 코끼리 모양 버튼을 선택합니다 (빨간 동그라미).

• 팝업창에 gradle singingReport 를 입력하면, 하단에서 SHA1 key를 얻을 수 있습니다.

• SHA1 key를 얻은 후 app으로 바꿔주는 거 잊지마세요!

google-services.json 파일 추가

• app 하위 디렉토리에 추가해야 합니다. 보기 방식을 project로 두고 하면 편해요 ~

SDK, gradle 설정

gradle (app)

• plugins에 id 'com.google.gms.google-services' 추가
• dependencies에 다음 코드 추가

    implementation platform('com.google.firebase:firebase-bom:31.1.1')
    implementation 'com.google.firebase:firebase-analytics-ktx'
    implementation 'com.google.firebase:firebase-messaging-ktx'

  gradle (project)

• 제가 사용한 안드로이드 스튜디오 버전(Dolphin 2021.3.1)에서는 project gradle의 구조가 바뀌어서, Firebase Console에 안내되어 있는 부분과는 조금 달랐습니다. 하지만 당황하지 않고 해주시면 돼요!

  buildscript {
    repositories {
        google()
    }
    dependencies {
        classpath 'com.google.gms:google-services:4.3.13'
    }
  }

  위 코드를 추가해줍니다.

Google Play Services 설치

• SDK Manager -> SDK Tools 에서 Google play services 검색 & 설치

• FirebaseMessagingService를 상속받는 FCM 서비스 클래스 생성

    import ...
    import com.google.firebase.messaging.FirebaseMessagingService
    import ...
  
    class Service이름: FirebaseMessagingService() {
  
    }

• Manifest에 서비스 등록

  <application
    ...  >
  
    <service
        android:name=".Service이름"
        android:exported="false">
    <intent-filter>
        <action android:name="com.google.firebase.MESSAGING_EVENT" />
    </intent-filter>
    </service>
  
    ...
  

FCM Test

1. Firebase Console에 접속하여 빌드 -> Cloud Messaging 를 선택해줍니다.
2. 캠페인 만들기를 누르고, Firebase 알림 메시지를 선택합니다.
3. 메시지를 작성한 후 테스트 메시지를 전송합니다. (제목(title), 텍스트(body))
4. FCM 등록 토큰 추가에서 토큰값을 추가합니다.

• 이 때 token을 알기 위한 방법은 아래 두 가지가 있어요. (1) 앱 최초 실행 시 생성되는 토큰값을 불러오기

    override fun onNewToken(token: String) {
          // token이 생성될 때 호출되는 함수
        // token이 생성되는 경우: 앱을 (재)설치 후 첫 실행될 때
        Log.d(TAG, "Token created: $token")
    }

  (2) FirebaseMessaging의 getInstance로 토큰값 가져오기

    fun getToken(): String? {
        var token: String? = null
  
        FirebaseMessaging.getInstance().token
            .addOnCompleteListener(OnCompleteListener { task ->
                if(!task.isSuccessful) {
                    return@OnCompleteListener
                }
                token = task.result
                Log.d(TAG, "Token: $token")
        })
        return token
    }    

메세지 수신하기

background 에서는 별도의 작업 없이 알림이 잘 오지만, foreground에서도 알람을 받기 위해서는 어떻게 해야 할까요? -> 받은 알람 데이터를 처리하는 onMessageReceived() method에서 notification을 만들어줍니다.

override fun onMessageReceived(message: RemoteMessage) {
    message.notification?.let {
        showNotification(it)
    }
}

private fun showNotification(notification: RemoteMessage.Notification) {
    val intent = Intent(this, MainActivity::class.java)
        // PendingIntent: 노티를 터치했을 때 액티비티를 실행하기 위함
    val pIntent = PendingIntent.getActivity(this, 0, intent, PendingIntent.FLAG_UPDATE_CURRENT) 

    val channelId = getString(R.string.fcm_channel_id)

    val notificationBuilder = NotificationCompat.Builder(this, channelId)
        .setPriority(NotificationCompat.PRIORITY_HIGH)
        .setSmallIcon(R.mipmap.ic_launcher)              // 알림에 보이는 아이콘
        .setContentTitle(notification.title)             // 알림에 보이는 제목
        .setContentText(notification.body)               // 제목 아래 보이는 텍스트
        .setContentIntent(pIntent)

    getSystemService(NotificationManager::class.java).run {         // 채널 생성
        if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {
            val channel = NotificationChannel(channelId, "알림", NotificationManager.IMPORTANCE_HIGH)
            createNotificationChannel(channel)
        }

        notify(Date().time.toInt(), notificationBuilder.build())     // 노티 등록
    }
}

channelId

그런데, 위의 코드에 나오는 channelId는 무엇일까요? 궁금증이 생겨 찾아보았습니다 -> 공식 링크 및 참고 링크 위의 링크들을 보았는데, 저는 여러 채널을 이용하지 않을 예정이라 우선 strings.xml에 임의의 아이디를 작성해주는 방식으로 진행했습니다.

PendingIntent

PendingIntent는 당장은 수행되진 않지만, 특정 시점이 되었을 때 실행되는 intent 입니다. 위에서는 notification을 선택했을 때 activity를 실행하기 위해 쓰이고 있어요.

pending intent를 생성하는 코드는 다음과 같습니다. PendingIntent.getActivity(context, requestCode, intent, flag)

FLAG

Pending Intent의 FLAG는 다음과 같이 있습니다.

그리고 현재 버전에서는 PendingIntent.MUTABLE , PendingIntent.IMMUTABLE 중 하나는 반드시 포함해야 돼요. (immutable 사용이 권장되고 있습니다.)

requestCode

PendingIntent.getActivity(this, 0, intent, PendingIntent.FLAG_UPDATE_CURRENT) 에서 0 이 requestCode입니다. requestCode는 pending intent를 가져올 때 이를 구분하기 위한 고유 코드값이에요.

보통 request code를 0으로 많이 작성하는데, 저는 웹앱 개발 과정에서 다음과 같은 문제가 발생했었어요.

foreground 상태에서 fcm 메시지가 연달아 도착했을 때, 각각을 클릭하면 각각의 다른 페이지가 아닌 똑같은 페이지로 이동된다.

peding intent가 중복되는 문제였습니다. 이 때 requestCode를 0이 아니라 (int) System.currentTimeMillis()를 줌으로써 동일한 값이 들어가지 않도록 했더니 해결되었답니다 :)

참고자료

https://donghun.dev/Firebase-Cloud-Messaging https://firebase.google.com/docs/cloud-messaging?hl=ko https://doitddo.tistory.com/108 https://velog.io/@haero_kim/Android-PendingIntent-%EA%B0%9C%EB%85%90-%EC%9D%B5%ED%9E%88%EA%B8%B0 https://developer88.tistory.com/187

Kotlin 기초

Conditionals

1. if - else if - else 이것은 굳이 설명 없이 넘어갈게요!

2. when if - else 에서 조건이 많을 경우 when을 사용하면 좋습니다.

   when (parameter) {
    condition1 -> body1
    condition2 -> body2
   }
   

// 예시: 다음과 같이 사용할 수 있어요. when (x) { 1 -> println("1") 2 -> println("2") 3, 5 -> println("3 or 5") in 10..19 -> println("10 ~ 19") is Int -> println("Int") }

## nullability
? 를 사용하면 nullable,
!! 를 사용하면 non-null 값입니다.
``` kotlin
var str ?= null
println(str?.length)    // print null
println(str!!.length)    // null exception

?: (Elvis 연산자)를 사용할 수 있어요.

val len = str?.length ?: 0    
// str이 null인 경우 print 0

class and object

객체로 인스턴스화

val name = ClassName()

constructor

class SmartDevice(
    val name: String, val category: String    // primary constructor
) {
    var deviceStatus = "online"

    constructor(    // 부생성자
        name: String, category: String, statusCode: Int
    ) : this(name, category) {  //  this(주생성자의 파라미터)
        deviceStatus = when (statusCode) {
            0 -> "offline"
            1 -> "online"
            else -> "unknown"
        }
    }
    ...
}

IS-A , HAS-A

// IS-A (Inherits) - 상속
// A: subClass, B: superClass
open B { fun func() }    // using `open` keyword in superclass 
class A : B() { 
    override fun func() {}    // using `override` keyword in subclass
}

// HAS_A (contains/uses) - 포함
class A(
    val b: B
)

visibility modifiers

using function as a data type

(parameters) -> return type

val coins: (Int) -> String { quantity ->
    "$quantity quarters"
}

repeat

for (iteration in start..end) { } => repeat(times) { iteration -> }

How to Debug (Android Studio)

앱 프로세스에 디버거 연결

1. 앱을 실행한다.
2. 기기 or 에뮬레이터가 실행되면 아래 사진 속 버튼을 누르고, 연결할 프로세스를 선택한다.
3. 하단에 Debug창이 표시된다.

디버거로 앱 실행

1. Debug 'app' 클릭
2. 하단에 Debug창이 표시된다.

Debug 기능

자세한 건 링크 참고 !!

• Debug 창에는 Debugger, Console 버튼이 있다.

  • Debugger: 별도의 창 3개를 표시 (Frames, Variables, Overhead)

    • Frames: 중단점이 설정된 줄이 강조표시 되어있음

      • Variables: 변수 검사 기능

  • Console: logcat 출력 표시

• 중단점 기능: 특정 코드 줄 번호 옆의 여백을 클릭 (다시 클릭하면 중단점 삭제)

• 중단 후 재개: Resume Program

• Step Into: 명령이 메서드 또는 다른 코드를 호출하는 경우, Step Into를 사용하면 디버거를 실행하여 중단점을 설정하기 전에 수동 탐색할 필요 없이 코드를 입력할 수 있다.

• Step Over: 런타임에 앱 코드를 단계별로 실행할 수 있다.

• Step Out: Step Into와 반대로 작동, 호출 스택으로 이동한다.

remember 함수를 이용한 상태 저장

remember 를 사용하여 리컴포지션에서 객체를 저장할 수 있다. 상태와 업데이트가 UI에 적절하게 반영되도록 일반적으로 remember과 mutableStateOf 함수가 함께 사용된다.

import androidx.compose.runtime.mutableStateOf
import androidx.compose.runtime.remember
import androidx.compose.runtime.getValue    // 직접 가져와야 함
import androidx.compose.runtime.setValue    // 직접 가져와야 함

var amount by remember { mutableStateOf("") }
TextField(                
    value = amount,
    onValueChanged = { amount = it },
)

by : Kotlin 속성 위임에 해당됨

상태 Hoisting

Stateful vs Stateless

• Stateful: 시간이 지남에 따라 변할 수 있는 상태를 소유하고 있음

• Stateless: 구성 가능한 함수에서 상태를 추출할 때 결과로 생성되는 구성 가능한 함수, 상태가 없는 컴포저블임

  hoisting이 필요한 경우

• 상태를 여러 구성 가능한 함수와 공유하는 경우

• 앱에서 재사용할 수 있는 Stateless 컴포저블을 만드는 경우

  상태 Hoisting을 Composable에 적용

• 컴포저블에 매개변수 2개가 추가되는 경우가 많다

  • value: T

  • onValueChange: (T) -> Unit // 값을 업데이트하는 람다 콜백

    @Composable
    fun TipTimeScreen() {
    var amountInput by remember { mutableStateOf("") }
    
    val amount = amountInput.toDoubleOrNull() ?: 0.0
    val tip = calculateTip(amount)
    
    Column(
     modifier = Modifier.padding(32.dp),
     verticalArrangement = Arrangement.spacedBy(8.dp)
    ) {
     Text(
         text = stringResource(R.string.calculate_tip),
         fontSize = 24.sp,
         modifier = Modifier.align(Alignment.CenterHorizontally)
     )
     Spacer(Modifier.height(16.dp))
     EditNumberField(value = amountInput,
         onValueChange = { amountInput = it }
     )
     Spacer(Modifier.height(24.dp))
     Text(
         text = stringResource(R.string.tip_amount, tip),
         modifier = Modifier.align(Alignment.CenterHorizontally),
         fontSize = 20.sp,
         fontWeight = FontWeight.Bold
     )
    }
    

}

@Composable fun EditNumberField( value: String, onValueChange: (String) -> Unit ) { TextField( value = value, onValueChange = onValueChange, label = { Text(stringResource(R.string.cost_of_service)) }, modifier = Modifier.fillMaxWidth(), singleLine = true, keyboardOptions = KeyboardOptions(keyboardType = KeyboardType.Number) ) }

- `amountInput` 상태를 `EditNumberField()`에서 `TipTimeScreen()` composable로 호이스팅

Compose 예시

우선 Compose 코드는 어떤 구성을 갖고 있을까요?

class MainActivity : ComponentActivity() {
   override fun onCreate(savedInstanceState: Bundle?) {
       super.onCreate(savedInstanceState)
       setContent {
           GreetingCardTheme {
               Surface(color = MaterialTheme.colors.background) {
                   Greeting("Android")
               }
           }
       }
   }
}

@Composable
fun Greeting(name: String) {
   Surface(color = Color.Magenta) {
       Text(text = "Hello $name!")
   }
}

@Preview(showBackground = true)
@Composable
fun DefaultPreview() {
   GreetingCardTheme {
       Greeting("Meghan")
   }
}

위의 코드를 Android Studio에서 작성하고, 우측 상단 Split을 누르면 Preview 화면을 동시에 볼 수 있습니다. 작성한 코드와 Preview 화면은 다음과 같아요!

Compose 관련 코딩 컨벤션 및 특징

Compose 함수의 특징

• UI 일부를 설명합니다.
• 아무것도 반환하지 않습니다.
• 몇 개의 입력을 받아서 화면에 표시되는 내용을 생성합니다.
• 여러 UI 요소를 내보낼 수도 있습니다.

Compose 함수의 이름

• 첫 글자는 대문자로 표기한다.

• 함수 이름은 명사여야 한다.

  • 동사 / 동사구 ❌ : DrawTextField()
  • 명사화된 전치사 ❌ : TextFieldWithLink
  • 형용사 ❌ : Bright()
  • 부사 ❌ : Outside()
  • 형용사+명사는 ⭕ : RoundIcon()

• 함수 앞에 @Composable 주석을 추가한다.

  • Compose 컴파일러에게 이 함수가 데이터를 UI로 변환함을 알리기 위함.

Preview

• @Preview로 미리보기가 가능하다.

  @Preview
  @Composable
  fun DefaultPreview() {
   GreetingCardTheme {
       Greeting("Meghan")
   }
  }

• Preview에 매개변수를 전달할 수 있다.

  @Preview(showBackground = true)    // 배경화면 미리보기
  
  

@Preview( name = "My Preview", // Preview에 제목 지정 showSystemUi = true // 시스템UI (휴대전화 화면)을 포함한 미리보기 )

# Composable
## Text
```kotlin
Text(
    text = message,                    // 표시할 메시지
    fontSize = 36.sp,                // 글씨 크기
    fontWeight = FontWeight.Bold,    
    modifier = Modifier
        .fillMaxWidth()
        .wrapContentWidth(Alignment.CenterHorizontally)
        .padding(start = 16.dp, top = 16.dp)
)

Image

• Image 파일을 Resource Manager을 사용하여 import하기 (설명 링크)

  Image(
    painter = painterResource(id = R.drawable.androidparty),
    contentDescription = null,           // (접근성 관련) 컨텐츠에 대한 설명
    modifier = Modifier
        .fillMaxHeight()
        .fillMaxWidth(),
    contentScale = ContentScale.Crop    // 이미지 scale type
  )

  다양한 이미지 scale type 종류들을 사진으로 잘 정리해둔 링크를 발견해서 함께 첨부합니다! (여기~)

+) Modifier

• Compose UI 구성요소들을 꾸미거나, 행동을 추가하기 위한 요소들의 모임

  modifier = Modifier
    // 높이 및 너비 관련
    .width(100.dp)             
    .height(100.dp)
    .fillMaxWidth(1f)    //  전체 대비 채우는 비율 (1f가 기본)
    .fillMaxHeight()
    .fillMaxSize()
    // 여유 공간
    .padding(15.dp)        // 상하좌우 15dp 여백
                        // start,end,top,bottom 이나 horizontal, vertical 값을 줄 수 있음
                        // margin을 주는 방법 -> 항목들 사이에 Spacer 추가하기
    // 배경 및 모양
    .background(
        color = Color.Blue,                    // 배경색
        shape = RoundedCornerShape(12.dp)    // 모양
    )
  

위 코드의 참고 출처 및 그 외의 다양한 Modifier 활용을 보고자 한다면 -> [링크](https://kotlinworld.com/191)로 !

## Spacer
- 요소들 사이 배치, margin을 주는 역할
```kotlin
Text( /* ... */ )
Spacer(Modifier.size(padding))
Row() { /* ... */ }

표준 레이아웃

Row

• 하위 요소들을 화면에 수직으로 배치
• LinearLayout(orientation = vertical)

  Row {
    Text("First")
    Text("Second")
  }

  Column

• 하위 요소들을 화면에 수평으로 배치
• LinearLayout(orientation = horizontal)

  Column(
    modifier = Modifier
  ) {
    Text("First")
    Text("Second")
  }

  Box

• 위젯을 다른 화면의 위에 배치
• 하나의 박스 만들고, 안에 요소들을 배치 가능 (하나는 왼쪽 위에, 하나는 오른쪽 아래에 놓는다던가..)

Jetpack Compose Camp 2022 For Beginners에 참여했습니다! (사실 기간 도중에 알게되어 거의 11월 중하순.. 늦게 참여했는데 다행히 이수했답니다😆) 행사를 통해 얻은 Compose 및 Kotlin 지식들을 정리하고 회고해보고자 합니다. 코드들은 여기에 있어요 ~

그래서, Compose는 무엇이고, 왜 사용해야 하는가?

여담이지만 뭐든 왜 쓰는지 왜 돌아가는지는 아는게 중요한 듯 합니다...

What is Compose?

(출처: android developer 공식 사이트)

Android Jetpack Compose는 Kotlin으로 제작된 라이브러리로 새로운 UI Tool 입니다! 선언형 프로그래밍 방식으로 UI를 그립니다.

기존에는 xml을 사용하여 UI를 그렸는데, 왜 compose가 생겨났고 그래서 왜 이걸 사용해야 한다는 걸까요?

Why Compose?

안드로이드 Developsers 에서는 Compose를 채택하는 이유를 다음과 같이 소개합니다.

코드 감소

적은 수의 코드로 더 많은 작업을 하고 전체 버그 클래스를 방지할 수 있으므로 코드가 간단하며 유지 관리가 쉽습니다.

직관적

UI만 설명하면 나머지는 Compose에서 처리합니다. 앱 상태가 변경되면 UI가 자동으로 업데이트됩니다.

빠른 개발 과정

기존의 모든 코드와 호환되므로 언제 어디서든 원하는 대로 사용할 수 있습니다. 실시간 미리보기 및 완전한 Android Studio 지원으로 빠르게 반복할 수 있습니다.

강력한 성능

Android 플랫폼 API에 직접 액세스하고 기본적으로 지원되는 Material Design, Dark Theme, Animation 등을 사용해 멋진 앱을 만들 수 있습니다.

(출처는 여기)

그리고 실제 코드랩을 진행해보면서 직접 느낀 점은,

1. 오직 Kotlin으로만 작성하면 되기 때문에 처음 하시는 분들의 입장에서는 XML 사용을 익히는 것에 부담이 적어질 것으로 보이고,

2. 기존처럼 xml에서 ui를 구성하고 class에서 컨트롤하는 방식은 두 파일을 왔다갔다 하다보면 번거로움이 있었는데 compose를 통해 하나의 파일에서 심플하게 작업할 수 있어 (선언형이기 때문에!) 더욱 편리한 것 같습니다.

3. 그리고 Preview (실시간 미리보기)가 정말 편리한 것 같아요! 버튼 클릭 등의 간단한 동작들도 미리보기로 해볼 수 있어서 좋았어요 :) 아직은 좀 느리지만 이 부분은 점차 개선되겠죠ㅎㅎ!? (사실 웹 프론트 친구들 웹사이트 보면서 바로바로 코드 수정 부러웠단 말이죠.. 맨날 안드로이드 스튜디오로 run->기다림->실행->수정->run->기다림... 이던 나날들 ㅜ)

So...

지난 9월, 따끈따끈(?)한 1.2 버전이 출시되어 갓 안정화 단계에 들어선 Compose!

공식 사이트에서 언급한 장점들을 보면 사용하지 않을 이유가 없어보이기도 하고, 또 구글에서도 열심히 밀어주고 있는 듯하고, Compose에 대한 다양한 긍정적 사용 후기들이 보이기도 하고, 실제로 코드랩을 해보면서 편리함을 느끼기도 해서 앞으로 사용도가 많아지지 않을까 생각이 듭니다! :)

... 그래서, Compose 웨않써!? (급마무리)

한 달간 진행된 프리코스의 늦은 후기를 남겨봅니다,,

지원

처음에는 지원을 많이 고민했었습니다. 휴학을 오래 했기에 빨리 졸업하고 취업을 해야 한다는 부담감이 컸고, 10달 간의 교육을 할 수 있을지 용기가 나질 않기도 했습니다. 하지만, 될지 안될지도 모르는데 일단 지원 해보자!는 마음으로, 프리코스만이라도 하면 일단 좋은 거 아닌가는 마음으로 지원을 하게 되었습니다.

아, 지원서 작성부터도 정말 스스로에게 많은 고민을 하게 만드는 질문들이었어요! 작성 과정에서 스스로에게 많이 질문해보며 나를 돌아볼 수 있었던 것 같아요.

미션

그렇게 4주간의 프리코스 과정에 참여하게 되었습니다.

사실 프리코스의 미션들은 구현 자체는 어려운 미션들은 아니었습니다. 다만, 요구사항과 피드백을 지키면서, 좋은 코드를 작성하는 데에 시간이 많이 소모되었습니다.

이번 프리코스에서 피드백을 받으면서 제가 중점적으로 공부하고 익숙해지려 노력했던 부분들은 다음과 같아요.

• 코드 작성 및 네이밍 규칙 지키기
• Git 컨벤션 지키기
• 클린 코드 작성하기
• 코틀린 Collections 문법 익히고 적용하기 (자바와 다른 부분 중점으로!)
• 함수의 기능 작게 만들기
• 클래스 분리하고 객체를 객체스럽게 사용하기
• 필드 수 줄이기
• 테스트 코드도 잘 작성하기
• enum 클래스 활용하기

1주차: 온보딩

https://github.com/sujin9/kotlin-onboarding/tree/sujin9

7개의 문제가 있고 각각을 코틀린으로 푸는 미션이었습니다. 말 그대로 온보딩이기에 문제 난이도가 높지 않았고 요구사항도 많지 않았지만, 이 때부터 네이밍이나 코드를 깔끔하게 작성하기 위해 노력했어요.

2주차: 숫자 야구

https://github.com/sujin9/kotlin-baseball/tree/sujin9

이 때부터 본격적으로 테스트 코드에 대한 고민이 시작되었습니다. 테스트 코드가 모든 메소드에 대해 필요한가, (라이브러리를 실행하는 경우 등) 테스트가 어려운 코드는 어떻게 테스트를 해야 하는가 (입출력이 있는 경우 등) 하는 고민이 많이 되더라구요.

또한 설계 과정에서 어느 정도까지 설계하고 어느 정도까지 유연성을 두는지에 대한 고민도 하였습니다.

3주차: 로또

https://github.com/sujin9/kotlin-lotto/tree/sujin9

2주차의 고민들은 피드백을 통해 꽤나 상당부분 해소가 되었지만, 역시나 다른 고민들이 시작됩니다 ㅎㅎ.. 우선 enum 클래스 사용이 새롭게 요구되면서 이 부분을 많이 공부했어요. 처음 사용이기 때문에 어떻게 사용하는지를 익히려고 많이 했습니다. 또한, 왜 이걸 사용하지? 를 많이 생각해보았습니다. 제 생각으로는, 관련 있는 상수들을 enum 클래스 하나에 열거를 하게되면, enum이 추상클래스이기 때문에 다양하게 활용이 가능하고 클래스 내에서 함수를 이용할 수도 있어서 단순 상수 열거 이상의 기능을 해낼 수 있더라구요 :) 또한 클래스 분리를 하는 과정이 많이 어려웠는데요. 이 객체가 어떤 의미를 갖는 객체인지를 분명하게 하려 했지만, 그럼에도 이걸 이렇게 분리하는게 맞는지, 이걸 분리하는게 오히려 복잡해지는 것은 아닌지, 계속 코드를 작성하는 내내 고민하게 되더라구요 ㅠㅠ

4주차: 다리 건너기

https://github.com/sujin9/kotlin-bridge/tree/sujin9

마지막은, 역시 쉽지 않았습니다 ㅜ 이번에는 클래스들이 어느 정도 분리가 되어있는 상태에서 구현을 시작하게 되었습니다.

우선 InputView와 OutputView가 분리가 되었는데, 그러다보니 input할 때 예외처리 등이 inputView 내에서 또는 이를 호출한 함수에서 처리를 해야할지 등 역할을 명확하게 하는 부분에서 많이 고민하였습니다. (저는 우선 이 부분은 exception 관련 클래스를 따로 생성하여 inputView 내에서 이를 호출하고 검사한 후에 return 하도록 구현하였습니다.)

또한 4주차에서 가장 어렵게 느껴졌던 부분은 단위 테스트 작성인데, 클래스에 프로퍼티가 있거나 전역변수가 있는 경우 테스트 코드를 어떻게 작성해야 할지 고민이 많았습니다. 전역변수를 public으로 두고 직접 접근하는 방법도 있겠지만, 이는 적합하지 않은 방법인 것 같거든요!!

그리고 고민의 과정의 끝은, 결국 함수를 분리하는 것이었습니다. 예를 들면, 다리 건너기를 시작할 때 관련 변수들을 초기화하는 함수를 따로 만들어주는 거죠. 그렇다면, 테스트 코드 작성할 때 이 함수를 실행해준 후 테스트를 실행하면 되니까요! 코드가 단 한 줄이지만 이를 따로 함수로 만들어줘야 테스트가 용이해지는 경우도 있었습니다. 정말,, 함수는 줄여도 줄여도 끝이 없네요 (?)

회고

미션을 진행하다 보니 정말 시간이 쏜살같이 사라졌네요. 힘들지만 행복했던 4주였습니다. :) 어떻게 보면 굉장히 짧은 시간임에도 불구하고, 코드가 정말 많이 개선되고 스스로 성장했음이 크게 느껴집니다. 과거의 코드를 보면,,, 나 반성해 ,,,, 그렇지만 그만큼 발전했다는 것에 매우 기쁘고, 의미 있는 4주였던 것 같습니다.

위에서 언급한, 제가 익숙해지려 노력하고 공부한 부분들을 보시면 아시겠지만, 사실 좋은 알고리즘을 구현하고 효율적으로 코드를 짜기 보다는 가독성이 좋게, 깔끔하게, 그리고 테스트를 하기 용이하게 코드를 짜는 것을 많이 익힐 수 있던 시간이었습니다. 혼자가 아닌 협업에서는 서로 규칙을 지키고 읽기 쉬운 코드를 작성하는 게 정말 정말 중요하니까요 !

또한 테스트 코드 작성을 직접 해봄으로써, 사용법을 익히는 것에서 그치지 않고 이것이 왜 필요한지를 직접 느끼게 되었습니다. 긴 코드를 작성하고 프로그램을 짜다 보면 이게 맞는지 잘 모를 수 있지만, 함수가 작은 하나의 기능을 수행하도록 쪼개고 단위 테스트를 각각 실행한다면 더 자주 코드를 점검할 수 있고, 오류가 생기게 되는 경우도 적어지고 오류가 생기더라도 원인을 훨씬 더 빠르게 찾을 수 있었습니다. 또한 테스트 코드로 함수가 잘 돌아가는지 확인하며 코드를 작성해나가니 더욱 코드를 짜는데 재미가 붙더라구요 (ㅋㅎㅋㅎ)

현생에 바빠서 여기에 온전히 몰입하지는 못했고, 그만큼 코드도 아쉬움이 남습니다. 하지만 만약 합격하게 된다면, 그 때는 졸업 이후이니 정말 여기에만 몰입할 수 있겠지요! 그렇지만 혹여 합격하지 못하게 되더라도, 4주 간의 이 경험이 있기에 충분히 값진 시간이었고 지원한 것을 전혀 후회하지 않습니다! :) (사실 전공 과목 기말고사와 우테코 최종 코테가 시간이 완전히 겹쳐버려서.. 어떻게 될지 모르겠네요 ㅠㅠ눈물)

그렇지만 이번에 배운 것을 잊지 않고, 더 공부하면서 앞으로 더 좋은 코드를 작성하도록 꾸준히 노력해야겠습니다 :)

기업 혹은 단체 내에 지켜야할 특정 컨벤션이 따로 있는 경우가 아니라면, 개인적으로 편하게 사용하기 매우 좋은 것 같습니다 😊

설치

IntelliJ - File - Settings - Plugins에 가서 git commit을 검색하면 Git Commit Template가 나옵니다. 바로 Install 해주면 끝입니다 ! (매우 간단하지요 ~)

사용

commit 버튼을 누르면 좌측에 이런 부분이 보일 텐데요, (물론 캡처 사진에는 변경된 파일은 없지만요🤣) 하단에 빨간 동그라미 부분에 보이는 버튼을 눌러줍니다.

그러면 다음과 같이 새로운 창이 뜹니다! 자주 쓰이는 type들이 있고, 하단에는 제목, 설명(본문), 관련 이슈 등을 작성할 수 있습니다.

Scope of this change : scope Short description : subject Long description : body Breaking changes : footer - 주요변경내역 Closed issues : footer - 관련 이슈

작성을 하면 다음과 같은 형태로 메시지가 생성됩니다.

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

활용

만약에 다음과 같이 작성을 했다고 하면,

다음과 같이 메시지가 작성된 모습을 볼 수 있습니다 😉

왜 필요한가

서로 협업을 할 때, 내가 커밋 메시지를 '잘' 작성했다면 함께 협업하는 동료들, 그리고 미래의 나 에게도 당시 코드의 의미와 변경사항 등을 알 수 있게 해줍니다. 물론 코드를 읽는 것으로도 얼추 알 수 있겠지만 (가독성이 좋다면 !?) 메시지를 통해 직관적으로 빠르게 알려준다면 코드를 읽기에도 수월해지고 시간도 절약되겠죠 !

다만, 메시지를 내 맘대로 적으면 상대방이 엥?? 할 수도 있으니, 간결하고 읽기 쉽게, 규칙을 지켜서 메시지를 작성하여 읽는 사람 누구나 알기 쉽게 하는 것이 중요합니다 - !

구조 및 규칙

이미 많은 개발자들이 사용하고 있는, 관용적으로 쓰이는 스타일들이 존재합니다.

일반적으로 많이 사용되는 구조는 다음과 같습니다.

type: subject body
footer

type은 필수로 작성해야 하고, body와 footer는 상황에 맞게 선택해서 쓰면 됩니다.

또한 각 사항들은 빈 줄로 구분합니다.

subject : What

type: subject

• 가급적 50자 이하로 쓴다.

• 최대한 간결하게 작성한다.

• 현재시제, 명령형의 동사로 시작한다.

• 첫 글자는 대문자로 시작한다.

• 마침표는 생략한다.

• type

  • FEAT : 새로운 기능 추가
  • FIX : 버그 수정
  • DOCS : 문서 수정
  • STYLE : code formatting, 세미콜론 누락, 코드 변경이 없는 경우
  • REFACTOR : 코드 리팩토링
  • TEST : 테스트 코드, 리팩토링 테스트 코드 추가
  • CHORE : 빌드 업무 수정, 패키지 매니저 수정

body : Why

• 72자 단위로 줄바꿈을 한다.

• 변경사항 중 무엇을, 왜 했는가를 설명한다.

• 어떻게(How)는 설명하지 않는다.

• 제목에서 부족한 내용을 보충한다.

footer

• issue tracker ID를 작성하는 경우에 사용한다.

참고

https://haesoo9410.tistory.com/299 https://velog.io/@rladpwl0512/Git-commit-%EB%A9%94%EC%8B%9C%EC%A7%80-%EC%BB%A8%EB%B2%A4%EC%85%98

지원 & 사전 문제 풀이

신청 접수를 하고 나면 사전 문제 풀이를 하라고 메일을 받게 됩니다. 사전 문제를 풀 수 있는 삼성 알고리즘 학습 사이트인 SW Expert Academy 링크를 줍니다.

참고로 위의 사이트에 가입할 때, 지원할 때 사용한 이메일과 같은 이메일을 사용해야 하기 때문에, 이미 이 사이트에 가입했던 사람은 지원할 때도 같은 이메일 주소를 내는 것이 좋을 것 같아요!

따로 코딩테스트처럼 모두가 같은 시간에 정해진 시간에 푸는 것이 아니고 기간 내에 풀이를 하면 됐는데, 당시에는 포스터에 쓰여있듯이 5일 정도의 시간이 주어졌습니다. 총 2문제였는데, 1번은 간단한 탐색 구현으로 난이도가 어렵지 않았고, 2번은 API 구현이었는데 난이도가 조금 있었습니다. 저는 2번 문제의 일부 테스트케이스가 시간 초과를 했어서 결과를 보니 1.8솔 정도였어요!

교육 과정

그 이후 합격 메일을 받았고, 오리엔테이션을 시작으로 6주간의 과정이 시작되었습니다.

6주 간의 과정은 기초 학습(4주)과 실전 학습(2주)로 이루어져 있습니다.

기초 학습의 경우는, 매일 텍스트로 주어진 알고리즘 내용이 주어지며, 온라인 강의들을 시청하고 관련 문제 풀이를 해야합니다. 문제의 수는 매일 달랐고, 난이도도 다양했기 때문에 생각보다 시간이 오래 걸렸습니다.

실전 학습의 경우는, 삼성 검정 시험 B형 (Pro) 수준의 문제들을 풀게 됩니다. 높은 난이도이기에 하루에 한 문제를 풀고, 해설 강의를 보는 방식으로 진행되었습니다. 그리고 B형을 풀기 위한 팁을 알려주는 시간도 있었는데, 실전 문제를 풀 때 배운 팁을 활용해 실전인 것처럼 풀이하는 것이 도움이 되었습니다.

삼성 SW 검정 시험 B형

교육생들에게는 실제 B형 시험을 볼 수 있는 기회 2번이 주어졌습니다. 용인 인재개발원에 가서 시험을 봤는데, 시설이 너~무 좋아서 기분이 좋았던..🤣🤣 하지만 시험은 역시 정말 어려웠답니다...ㅠㅠ (결국 통과 못했다는 얘기)

아 그리고 저는 검정 시험 2번 다 '공부하고 제일 마지막 날짜에 봐야지' 했다가 가장 마지막 시험 날짜에 다른 기업 코테와 일정이 겹쳐서 결국 1번만 응시하게 된 점은 많이 아쉬움이 남습니다. 만약 저처럼 취업 준비를 하실 예정이라면 일정을 잡는 데 참고하시면 좋을 것 같습니다 :)

이후 추가 응시 여부 메일이 왔으나 다른 코테랑 또 겹쳐버렸다...ㅠㅠ

후기 & 팁

위의 과정들은 6주 간 매일 매일 이뤄지기에 솔직하게 시간적으로 여유가 많이 없었습니다. 그래도 한 마디로 얘기하면 방학 동안 알고리즘 올인한 느낌 !

또한 위의 교육을 듣는 과정이, 매일 매일 여기까지 하세요-가 아니라, 본인 일정에 맞게 공부해서 교육 마감일 전까지 수강 완료 하세요! 이기 때문에, 스스로 시간을 잘 관리하고 자기주도적으로 학습해야 합니다. 하지만 나의 일정에 맞춰 공부할 수 있다는 점이 아주 큰 장점이죠 !! 그러나 한 번 밀리면.. 죽음 뿐... _TMI) 실제로 부산 여행 갔다와서 밀린 내용 공부 하려다가 힘들어서 죽는 줄 알았답니다..🤣 _

하지만 알고리즘을 카테고리별로 공부하고, 양질의 자료들을 많이 제공해주기 때문에 본격적으로 코딩테스트를 준비하기 전 기초를 다지는데 도움이 많이 되어서 매우 만족스러웠습니다 ! 그리고 이 일정을 모두 소화하고 수료증을 받았을 때의 뿌듯함은 보너스 ㅎㅎ (수료증은 메일로 pdf 파일을 받았습니다!)

결국 결론은, 힘들었지만 수료해서 정말 기쁘고요 ☺️ 코테 등 문제를 풀기 전에도 무작정 풀기보다는 다각도로 고민하면서 문제를 푸는 연습이 되었습니다. 알고리즘 이론을 잘 다지고 싶고 심도있게 공부하고 싶은 대학생분들에게는 매우 추천합니다 ! :)