Automatyczna obsługa plików cookie za pomocą OkHttp 3

Jeśli chcesz użyć nowego Okhttp 3 CookieJar i pozbyć się zależności okhttp-urlconnection możesz użyć tego PersistentCookieJar .

Wystarczy utworzyć instancję PersistentCookieJar, a następnie przekazać ją do konstruktora OkHttp:

CookieJar cookieJar =
                    new PersistentCookieJar(new SetCookieCache(), new SharedPrefsCookiePersistor(context));

OkHttpClient okHttpClient = new OkHttpClient.Builder()
                    .cookieJar(cookieJar)
                    .build();

Tutaj masz proste podejście do tworzenia własnych CookieJar. Może być przedłużony, jak chcesz. Co zrobiłem, to zaimplementować CookieJar i zbudować OkHttpClient przy użyciu OkHttpClient./ Align = "left" /

public class MyCookieJar implements CookieJar {

    private List<Cookie> cookies;

    @Override
    public void saveFromResponse(HttpUrl url, List<Cookie> cookies) {
        this.cookies =  cookies;
    }

    @Override
    public List<Cookie> loadForRequest(HttpUrl url) {
        if (cookies != null)
            return cookies;
        return new ArrayList<Cookie>();

    } 
}

Oto jak można utworzyć OkHttpClient

OkHttpClient.Builder builder = new OkHttpClient.Builder();
builder.cookieJar(new MyCookieJar());
OkHttpClient client = builder.build();

Dodawanie compile "com.squareup.okhttp3:okhttp-urlconnection:3.8.1" do Twojej kompilacji.gradle.

A następnie dodanie

 CookieManager cookieManager = new CookieManager();
 cookieManager.setCookiePolicy(CookiePolicy.ACCEPT_ALL);

 OkHttpClient defaultHttpClient = new OkHttpClient.Builder()
                                 .cookieJar(new JavaNetCookieJar(cookieManager))
                                 .build()

Pomógł mi bez dodawania zależności od innych firm, z wyjątkiem tej z OkHttp.

Tutaj działa implementacja CookieJar dla OkHttp3. Jeśli masz kilka instancji OkHttp3 (zazwyczaj powinieneś mieć tylko jedną instancję i używać jej jako singletone) powinieneś ustawić tę samą instancję cookiejar dla wszystkich klientów http, aby mogli udostępniać pliki cookie !!! Ta implementacja nie jest trwałe pliki cookie (wszystkie zostaną odrzucone przy ponownym uruchomieniu aplikacji), ale powinno być łatwe do wdrożenia SharedPreferences persistence zamiast listy plików cookie w pamięci (cookieStore).

    CookieJar cookieJar = new CookieJar() {
        private final HashMap<String, List<Cookie>> cookieStore = new HashMap<>();

        @Override
        public void saveFromResponse(HttpUrl url, List<Cookie> cookies) {
            cookieStore.put(url.host(), cookies);
        }

        @Override
        public List<Cookie> loadForRequest(HttpUrl url) {
            List<Cookie> cookies = cookieStore.get(url.host());
            return cookies != null ? cookies : new ArrayList<Cookie>();
        }
    };
    OkHttpClient httpClient = new OkHttpClient.Builder()
            .cookieJar(cookieJar)
            .build();

Użyłem franmontiel PeristentCookieJar biblioteki dla okhttp3 i retrofit.2. zaletą tego podejścia jest to, że nie trzeba manipulować żądaniem okhttp. Po prostu ustaw pliki cookie lub sesję podczas tworzenia retrofit

 allprojects {
     repositories {
         jcenter()
         maven { url "https://jitpack.io" }
     }
 }

    compile 'com.github.franmontiel:PersistentCookieJar:v1.0.1'

public static Retrofit getClient(Context context) {

            ClearableCookieJar cookieJar = new PersistentCookieJar(new SetCookieCache(), new SharedPrefsCookiePersistor(context));
            OkHttpClient okHttpClient = new OkHttpClient.Builder()
                    .cookieJar(cookieJar)
                    .build();
            if (retrofit==null) {
                retrofit = new Retrofit.Builder()
                        .baseUrl(BASE_URL)
                        .addConverterFactory(GsonConverterFactory.create())
                        .client(okHttpClient)
                        .build();
            }
            return retrofit;
        }

Minimalne rozwiązanie, które utrzymuje cookie po pierwszym uruchomieniu

public class SharedPrefCookieJar implements CookieJar {

    Map<String, Cookie> cookieMap = new HashMap();
    private Context mContext;
    private SharedPrefsManager mSharedPrefsManager;

    @Inject
    public SharedPrefCookieJar(Context context, SharedPrefsManager sharedPrefsManager) {
        mContext = context;
        mSharedPrefsManager = sharedPrefsManager;
        cookieMap = sharedPrefsManager.getCookieMap(context);
        if (cookieMap == null) {
            cookieMap = new HashMap<>();
        }
    }

    @Override
    public void saveFromResponse(HttpUrl url, List<Cookie> cookies) {

        for (Cookie cookie : cookies) {
            cookieMap.put(cookie.name(), cookie);
        }
        mSharedPrefsManager.setCookieMap(mContext, cookieMap);
    }

    @Override
    public List<Cookie> loadForRequest(HttpUrl url) {
        List<Cookie> validCookies = new ArrayList<>();
        for (Map.Entry<String, Cookie> entry : cookieMap.entrySet()) {
            Cookie cookie = entry.getValue();
            if (cookie.expiresAt() < System.currentTimeMillis()) {

            } else {
                validCookies.add(cookie);
            }
        }
        return validCookies;
    }

}

Ze sztyletem

@Module
public class ApiModule {


    @Provides
    @Singleton
    InstagramService provideInstagramService(OkHttpClient client)
    {
        Retrofit retrofit = new Retrofit.Builder()
                .baseUrl(InstagramService.BASE_URL)
                .client(client)
                .addConverterFactory(GsonConverterFactory.create())
                .addCallAdapterFactory(RxJava2CallAdapterFactory.create())
                .build();
        InstagramService instagramService = retrofit.create(InstagramService.class);
        return instagramService;
    }


    @Provides
    @Singleton
    OkHttpClient provideOkHttpClient(SharedPrefCookieJar sharedPrefCookieJar){
        OkHttpClient client;
        OkHttpClient.Builder builder = new OkHttpClient.Builder();
        if(BuildConfig.DEBUG)
        {
            HttpLoggingInterceptor httpLoggingInterceptor = new HttpLoggingInterceptor();
            httpLoggingInterceptor.setLevel(HttpLoggingInterceptor.Level.BODY);
            builder
                .addInterceptor(httpLoggingInterceptor)
                .addInterceptor(new InstagramHeaderInterceptor())
                .addNetworkInterceptor(new LoggingInterceptor());

        }
        client = builder.cookieJar(sharedPrefCookieJar).build();
        return client;
    }
}

Możesz spróbować w Kotlin :

val cookieJar = JavaNetCookieJar(CookieManager())
val url = "https://www.google.com/"

val requestBuilder = Request
        .Builder()
        .url(url)
        .get()

val request = requestBuilder
        .build()

val response = OkHttpClient.Builder()
        .cookieJar(cookieJar)
        .build()
        .newCall(request)
        .execute()

Gradle

dependencies {
    implementation("com.squareup.okhttp3:okhttp:4.2.2")
    implementation("com.squareup.okhttp3:okhttp-urlconnection:4.2.2")
}

Użyłem rozwiązania @ gncabrera, ale również stworzyłem klasę pomocniczą, aby pomóc w inicjalizacji, a także aby ułatwić udostępnianie pliku CookieJar w całej aplikacji.

public class OkHttpClientCreator {

    private static CookieJar mCookieJar;

    public static OkHttpClient.Builder getNewHttpClientBuilder(boolean isDebug, boolean useCookies) {
        if (mCookieJar == null && useCookies) {
            mCookieJar = new BasicCookieJar();
        }
        OkHttpClient.Builder builder = new OkHttpClient.Builder();
        if (useCookies) {
            builder.cookieJar(mCookieJar);
        }
        if (isDebug) {
            builder.addInterceptor(new LoggingInterceptor());
        }
        return builder;
    }

    public static OkHttpClient getNewHttpClient(boolean isDebug, boolean useCookies) {
       return getNewHttpClientBuilder(isDebug, useCookies).build();
    }

}

Logging interceptor jest używany w trybie debugowania do drukowania informacji o żądaniu, a instancja cookie jar jest udostępniana. przez wywołujących tak, że jeśli żądania muszą korzystać ze wspólnego obsługi plików cookie, mogą. Te pliki cookie nie będą przechowywane podczas uruchamiania aplikacji, ale nie jest to wymagane dla mojej aplikacji, ponieważ używamy tokena sesje oparte i jedyną potrzebą Ciasteczek jest krótki czas między zalogowaniem się a wygenerowaniem tokena.

Uwaga: BasicCookieJar jest po prostu tą samą implementacją co mycookiejar gncabrera

Dodaj wdrożenie " com.squareup.okhttp3: okhttp-urlconnection: 3.8.1 " do Twojej kompilacji.gradle.

var interceptor = HttpLoggingInterceptor().setLevel(HttpLoggingInterceptor.Level.BODY)
var cookieHandler: CookieHandler = CookieManager()

private var retrofit: Retrofit? = null
retrofit = Retrofit.Builder()
                        .baseUrl(BASE_URL)
                        .client(client)
                        .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
                        .build()

private val client : OkHttpClient
            private get() {
                val builder = OkHttpClient.Builder()
                builder.addNetworkInterceptor(interceptor)
                builder.cookieJar(JavaNetCookieJar(cookieHandler))
                builder.connectTimeout(15, TimeUnit.SECONDS)
                builder.readTimeout(20, TimeUnit.SECONDS)
                builder.writeTimeout(20, TimeUnit.SECONDS)
                builder.retryOnConnectionFailure(true)
                return builder.build()
            }

Mogę pokazać ci bibliotekę pozwalającą OkHttp3 automatycznie obsługiwać pliki cookie. Można go łatwo używać.

Po prostu Zachowaj pliki cookie w pamięci, aby zrobić trwałość samodzielnie, jeśli potrzebujesz. Uruchom na Androidzie i czystym środowisku Java.

    String url = "https://example.com/webapi";

    OkHttp3CookieHelper cookieHelper = new OkHttp3CookieHelper();

    OkHttpClient client = new OkHttpClient.Builder()
            .cookieJar(cookieHelper.cookieJar())
            .build();

    Request request = new Request.Builder()
            .url(url)
            .build();

Gradle

compile 'org.riversun:okhttp3-cookie-helper:1.0.0'

Maven

<dependency>
<groupId>org.riversun</groupId>
<artifactId>okhttp3-cookie-helper</artifactId>
<version>1.0.0</version>
</dependency>