update

Author: LeoAndo

.idea/AndroidProjectSystem.xml

@@ -11,12 +11,12 @@ try {
 }
 android {
     namespace 'com.template.androidbasicapp'
-    compileSdk 34
+    compileSdk 35
 
     defaultConfig {
         applicationId "com.template.androidbasicapp" // TODO applicationIdを他の人と被らない名前に変更してください。
         minSdk 29
-        targetSdk 34
+        targetSdk 35
         versionCode 130
         versionName "1.3.0"
 
@@ -54,8 +54,8 @@ android {
     }
 
     compileOptions {
-        sourceCompatibility JavaVersion.VERSION_1_8
-        targetCompatibility JavaVersion.VERSION_1_8
+        sourceCompatibility JavaVersion.VERSION_21
+        targetCompatibility JavaVersion.VERSION_21
     }
 
     buildFeatures {
@@ -88,25 +88,34 @@ android {
 
 dependencies {
     // UI
-    implementation("androidx.appcompat:appcompat:1.6.1")
-    implementation("com.google.android.material:material:1.10.0")
-    implementation("androidx.constraintlayout:constraintlayout:2.1.4")
-    implementation("androidx.lifecycle:lifecycle-livedata:2.6.2")
-    implementation("androidx.lifecycle:lifecycle-viewmodel:2.6.2")
-    implementation("androidx.navigation:navigation-fragment:2.7.4")
-    implementation("androidx.navigation:navigation-ui:2.7.4")
-    implementation 'com.google.android.gms:play-services-maps:18.2.0'
+    implementation("androidx.appcompat:appcompat:1.7.0")
+    implementation("com.google.android.material:material:1.12.0")
+    implementation("androidx.constraintlayout:constraintlayout:2.2.1")
+    implementation("androidx.lifecycle:lifecycle-livedata:2.9.0")
+    implementation("androidx.lifecycle:lifecycle-viewmodel:2.9.0")
+    implementation("androidx.navigation:navigation-fragment:2.9.0")
+    implementation("androidx.navigation:navigation-ui:2.9.0")
+    implementation 'com.google.android.gms:play-services-maps:19.2.0'
 
     // Unit Test
     testImplementation("junit:junit:4.13.2")
-    androidTestImplementation("androidx.test.ext:junit:1.1.5")
-    androidTestImplementation("androidx.test.espresso:espresso-core:3.5.1")
+    androidTestImplementation("androidx.test.ext:junit:1.2.1")
+    androidTestImplementation("androidx.test.espresso:espresso-core:3.6.1")
 
     // Local Database - Room
-    def room_version = "2.5.0"
+    def room_version = "2.7.1"
     implementation("androidx.room:room-runtime:$room_version")
     annotationProcessor("androidx.room:room-compiler:$room_version")
 
     // Image
     implementation "com.github.bumptech.glide:glide:4.13.2"
+
+    // Retrofit & okhttp3 & Gsonライブラリの追加 (Rxjavaは導入しない) - START
+    def retrofitVersion = "2.11.0"
+    implementation("com.squareup.retrofit2:retrofit:$retrofitVersion")
+    implementation("com.squareup.retrofit2:converter-gson:$retrofitVersion")
+    implementation(platform("com.squareup.okhttp3:okhttp-bom:4.12.0"))
+    implementation("com.squareup.okhttp3:okhttp")
+    implementation("com.squareup.okhttp3:logging-interceptor")
+    // END
 }

.idea/compiler.xml

@@ -18,4 +18,7 @@
 
 # If you keep the line number information, uncomment this to
 # hide the original source file name.
-#-renamesourcefileattribute SourceFile
+#-renamesourcefileattribute SourceFile
+
+# keep data package
+-keep class com.template.androidbasicapp.data.** { *; }

.idea/deploymentTargetSelector.xml

@@ -0,0 +1,132 @@
+package com.template.androidbasicapp.data;
+
+import androidx.annotation.NonNull;
+
+import com.template.androidbasicapp.BuildConfig;
+import com.template.androidbasicapp.exception.AppException;
+import com.template.androidbasicapp.exception.AppExceptionType;
+
+import java.io.IOException;
+import java.net.HttpURLConnection;
+import java.net.SocketException;
+import java.net.SocketTimeoutException;
+
+import okhttp3.Interceptor;
+import okhttp3.OkHttpClient;
+import okhttp3.Response;
+import okhttp3.logging.HttpLoggingInterceptor;
+import retrofit2.Call;
+import retrofit2.Retrofit;
+import retrofit2.converter.gson.GsonConverterFactory;
+
+/**
+ * RetrofitやOkHttpClientのインスタンスは基本的にアプリケーション全体で1つだけ（シングルトン）にするのが推奨される。
+ * 理由は以下の通り。
+ * Retrofitの生成コストが高いため、複数生成は非効率。
+ * RetrofitインスタンスをAPIごとに1つずつシングルトンで持つ設計が一般的。
+ */
+public final class ApiClient {
+    private static volatile GithubApiService githubApiService;
+    private static volatile OkHttpClient okHttpClient;
+
+    private ApiClient() {
+        throw new UnsupportedOperationException("ApiClient is a utility class and cannot be instantiated");
+    }
+
+    /**
+     * 通信ログをLogcatで確認できるようにInterceptorを追加したOkHttpClientを取得する。
+     * Logcatから「package:mine tag:okhttp.OkHttpClient」でフィリタリングすると確認しやすい。
+     * <p>
+     * スレッドセーフなシングルトンの実装はRoomライブラリなどの内部実装でも採用しているダブルチェックロッキングのパターンを採用した
+     *
+     * @return OkHttpClientのインスタンス
+     */
+    private static OkHttpClient getOkHttpClient() {
+        if (okHttpClient == null) {
+            synchronized (ApiClient.class) {
+                if (okHttpClient == null) {
+                    var builder = new OkHttpClient.Builder();
+                    if (BuildConfig.DEBUG) { // デバッグビルドの場合は、通信ログを出力する
+                        var loggingInterceptor = new HttpLoggingInterceptor();
+                        loggingInterceptor.setLevel(HttpLoggingInterceptor.Level.BODY);
+                        builder.addInterceptor(loggingInterceptor);
+                    }
+                    okHttpClient = builder.addInterceptor(new Interceptor() {
+                                @NonNull
+                                @Override
+                                public Response intercept(@NonNull Chain chain) throws IOException {
+                                    var url = chain.request().url(); // リクエストURLを取得
+                                    var host = url.host(); // ホスト名を取得
+
+                                    if (host.equals("api.github.com")) { // github.comのAPIの場合
+                                        // APIで必要なヘッダ情報は、ここで追加することも可能.
+                                        return chain.proceed(chain.request().newBuilder()
+                                                .addHeader("Accept", "application/vnd.github+json")
+                                                .addHeader("X-GitHub-Api-Version", "2022-11-28")
+                                                //.addHeader("Authorization", "Bearer TOKEN")
+                                                .build());
+                                    } else {
+                                        // それ以外のAPIは特にヘッダを追加する必要はない
+                                        return chain.proceed(chain.request());
+                                    }
+                                }
+                            })
+                            .build();
+                }
+            }
+        }
+        return okHttpClient;
+    }
+
+    public static GithubApiService getGithubApiService() {
+        if (githubApiService == null) {
+            synchronized (ApiClient.class) {
+                if (githubApiService == null) {
+                    var retrofit = new Retrofit.Builder()
+                            .baseUrl("https://api.github.com/")
+                            .client(getOkHttpClient())
+                            .addConverterFactory(GsonConverterFactory.create())
+                            .build();
+                    githubApiService = retrofit.create(GithubApiService.class);
+                }
+            }
+        }
+        return githubApiService;
+    }
+
+    /**
+     * RetrofitのCallを実行し、レスポンスボディを取得する.<br>
+     * Web API固有の処理が入る場合は、共通利用せずに、各APIでdataOrThrowメソッドを用意するのも良いかも<br>
+     *
+     * @param call RetrofitのCallオブジェクト
+     * @param <T>  レスポンスボディの型
+     * @return レスポンスボディ
+     * @throws AppException 通信エラーやレスポンスエラーが発生した場合にスローされる
+     */
+    public static <T> T dataOrThrow(@NonNull final Call<T> call) throws AppException {
+        try {
+            var response = call.execute(); // 通信を実行
+            var body = response.body(); // レスポンスボディを取得
+            var code = response.code(); // レスポンスコードを取得
+            if (response.isSuccessful() && body != null) {
+                return body; // 成功時はレスポンスボディを返す
+            } else { // 失敗時はレスポンスコードに応じて例外をスロー
+                if (code == HttpURLConnection.HTTP_UNAUTHORIZED) {
+                    throw new AppException("Unauthorized access", AppExceptionType.Unauthorized);
+                } else if (code == HttpURLConnection.HTTP_FORBIDDEN) {
+                    throw new AppException("Forbidden access", AppExceptionType.Forbidden);
+                } else {// 想定できていないエラーは一旦Unknownでまとめる
+                    throw new AppException("error HTTP code: " + code, AppExceptionType.Unknown);
+                }
+            }
+        } catch (IOException e) { // 通信処理に失敗した場合はIOExceptionをスロー
+            var message = e.getMessage() != null ? e.getMessage() : "error message is null";
+            if (e instanceof SocketTimeoutException || e instanceof SocketException) {
+                throw new AppException(message, AppExceptionType.Network);
+            } else {
+                // 想定できていないエラーは一旦Unknownでまとめる
+                throw new AppException(message, AppExceptionType.Unknown);
+            }
+        }
+    }
+}

.idea/misc.xml

@@ -0,0 +1,13 @@
+package com.template.androidbasicapp.data;
+
+import retrofit2.Call;
+import retrofit2.http.GET;
+import retrofit2.http.Query;
+
+/**
+ * Web API単位でインターフェースを定義する
+ */
+public interface GithubApiService {
+    @GET("search/repositories")
+    Call<GithubSearchResponse> searchRepositories(@Query("q") String q, @Query("sort") String sort);
+}

app/build.gradle

@@ -0,0 +1,17 @@
+package com.template.androidbasicapp.data;
+
+import androidx.annotation.NonNull;
+
+import com.google.gson.annotations.SerializedName;
+
+import java.util.List;
+
+public record GithubSearchResponse(@SerializedName("total_count") int totalCount,
+                                   @SerializedName("incomplete_results") boolean incompleteResults,
+                                   @NonNull List<Item> items) {
+    record Item(long id, @NonNull String name, Owner owner, @NonNull String html_url,
+                int stargazers_count, int forks_count) {
+        record Owner(@NonNull String login) {
+        }
+    }
+}

app/proguard-rules.pro

@@ -0,0 +1,19 @@
+package com.template.androidbasicapp.exception;
+
+import androidx.annotation.NonNull;
+
+/**
+ * ベースとなるアプリケーション固有のException
+ */
+public class AppException extends Exception {
+    private final AppExceptionType type;
+
+    public AppException(@NonNull final String message, @NonNull final AppExceptionType type) {
+        super(message);
+        this.type = type;
+    }
+
+    public AppExceptionType getType() {
+        return type;
+    }
+}