flutter_naver_login

Build Status Build Status Build Status Build Status Build Status

A Flutter plugin for using the native Naver Login SDKs on Android and iOS.

AndroidX support

Installation

To get things up and running, you'll have to declare a pubspec dependency in your Flutter project. Also some minimal Android & iOS specific configuration must be done, otherise your app will crash.

On your Flutter project

See the installation instructions on pub.

Android

This assume that you have performed the "link app to package name and base class the Naver Login documentation for Android site.

Your Application Info is shown in the for Naver Developer Website.

Then find out what the Client ID is. The Naver Client ID can be found on the Naver App Dashboard from the Naver Developer Console.

Once you find out your Naver Client ID, URL Scheme and Set Package Name you'll have to do some things.

Then simply copy and paste into ROOT.

<your project root>android/app/src/main/res/values/strings.xml

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <string name="client_id">[client_id]</string>
    <string name="client_secret">[client_secret]</string>
    <string name="client_name">[client_name]</string>
</resources>

<your project root>android/app/src/main/AndroidManifest.xml

 <application
        android:name="io.flutter.app.FlutterApplication"
        android:label="flutter_naver_login_example"
        android:icon="@mipmap/ic_launcher">
        <meta-data
            android:name="com.naver.sdk.clientId"
            android:value="@string/client_id" />
        <meta-data
            android:name="com.naver.sdk.clientSecret"
            android:value="@string/client_secret" />
         <meta-data
            android:name="com.naver.sdk.clientName"
            android:value="@string/client_name" />
			...

A sample of the file can be found here. here.

It is also necessary to uses FlutterFragmentActivity instead of FlutterActivity since uses of naver sdk 5.4.0.

import io.flutter.embedding.android.FlutterFragmentActivity

class MainActivity: FlutterFragmentActivity()

If you have android device back button issue, then you should add the following code.

import android.os.Build
import io.flutter.Log
import io.flutter.embedding.android.FlutterActivityLaunchConfigs.BackgroundMode
import io.flutter.embedding.android.FlutterFragment
import io.flutter.embedding.android.FlutterFragmentActivity
import io.flutter.embedding.android.RenderMode
import io.flutter.embedding.android.TransparencyMode
import io.flutter.embedding.engine.FlutterShellArgs


class MainActivity: FlutterFragmentActivity() {
    private val TAG = "FlutterFragmentActivity"

    // This is same as FlutterFragmentActivity.createFlutterFragment(), but only difference is shouldAutomaticallyHandleOnBackPressed(Build.VERSION.SDK_INT >= 33) added.
    // See the https://github.com/flutter/flutter/issues/117061
    override fun createFlutterFragment(): FlutterFragment {
        val backgroundMode = backgroundMode
        val renderMode = getRenderMode()
        val transparencyMode =
            if (backgroundMode == BackgroundMode.opaque) TransparencyMode.opaque else TransparencyMode.transparent
        val shouldDelayFirstAndroidViewDraw = renderMode == RenderMode.surface
        if (cachedEngineId != null) {
            Log.v(
                TAG,
                "Creating FlutterFragment with cached engine:\n"
                        + "Cached engine ID: "
                        + cachedEngineId
                        + "\n"
                        + "Will destroy engine when Activity is destroyed: "
                        + shouldDestroyEngineWithHost()
                        + "\n"
                        + "Background transparency mode: "
                        + backgroundMode
                        + "\n"
                        + "Will attach FlutterEngine to Activity: "
                        + shouldAttachEngineToActivity()
            )
            return FlutterFragment.withCachedEngine((cachedEngineId)!!)
                .renderMode(renderMode)
                .transparencyMode(transparencyMode)
                .handleDeeplinking(shouldHandleDeeplinking())
                .shouldAttachEngineToActivity(shouldAttachEngineToActivity())
                .destroyEngineWithFragment(shouldDestroyEngineWithHost())
                .shouldDelayFirstAndroidViewDraw(shouldDelayFirstAndroidViewDraw)
                .shouldAutomaticallyHandleOnBackPressed(Build.VERSION.SDK_INT >= 33)
                .build()
        } else {
            Log.v(
                TAG,
                ("Creating FlutterFragment with new engine:\n"
                        + "Cached engine group ID: "
                        + cachedEngineGroupId
                        + "\n"
                        + "Background transparency mode: "
                        + backgroundMode
                        + "\n"
                        + "Dart entrypoint: "
                        + dartEntrypointFunctionName
                        + "\n"
                        + "Dart entrypoint library uri: "
                        + (if (dartEntrypointLibraryUri != null) dartEntrypointLibraryUri else "\"\"")
                        + "\n"
                        + "Initial route: "
                        + getInitialRoute()
                        + "\n"
                        + "App bundle path: "
                        + getAppBundlePath()
                        + "\n"
                        + "Will attach FlutterEngine to Activity: "
                        + shouldAttachEngineToActivity())
            )
            return if (cachedEngineGroupId != null) {
                FlutterFragment.withNewEngineInGroup((cachedEngineGroupId)!!)
                    .dartEntrypoint(dartEntrypointFunctionName)
                    .initialRoute(getInitialRoute())
                    .handleDeeplinking(shouldHandleDeeplinking())
                    .renderMode(renderMode)
                    .transparencyMode(transparencyMode)
                    .shouldAttachEngineToActivity(shouldAttachEngineToActivity())
                    .shouldDelayFirstAndroidViewDraw(shouldDelayFirstAndroidViewDraw)
                    .shouldAutomaticallyHandleOnBackPressed(Build.VERSION.SDK_INT >= 33)
                    .build()
            } else {
               return if (dartEntrypointLibraryUri == null) {
                    FlutterFragment.withNewEngine()
                        .dartEntrypoint(dartEntrypointFunctionName)
                        .dartEntrypointArgs((dartEntrypointArgs) ?: listOf<String>())
                        .initialRoute(getInitialRoute())
                        .appBundlePath(getAppBundlePath())
                        .flutterShellArgs(FlutterShellArgs.fromIntent(intent))
                        .handleDeeplinking(shouldHandleDeeplinking())
                        .renderMode(renderMode)
                        .transparencyMode(transparencyMode)
                        .shouldAttachEngineToActivity(shouldAttachEngineToActivity())
                        .shouldDelayFirstAndroidViewDraw(shouldDelayFirstAndroidViewDraw)
                        .shouldAutomaticallyHandleOnBackPressed(Build.VERSION.SDK_INT >= 33)
                        .build()
                } else
                FlutterFragment.withNewEngine()
                    .dartEntrypoint(dartEntrypointFunctionName)
                    .dartLibraryUri((dartEntrypointLibraryUri)!!)
                    .dartEntrypointArgs((dartEntrypointArgs) ?: listOf<String>())
                    .initialRoute(getInitialRoute())
                    .appBundlePath(getAppBundlePath())
                    .flutterShellArgs(FlutterShellArgs.fromIntent(intent))
                    .handleDeeplinking(shouldHandleDeeplinking())
                    .renderMode(renderMode)
                    .transparencyMode(transparencyMode)
                    .shouldAttachEngineToActivity(shouldAttachEngineToActivity())
                    .shouldDelayFirstAndroidViewDraw(shouldDelayFirstAndroidViewDraw)
                    .shouldAutomaticallyHandleOnBackPressed(Build.VERSION.SDK_INT >= 33)
                    .build()
            }
        }
    }
}

Proguard Support

## From https://github.com/naver/naveridlogin-sdk-android/blob/master/Samples/proguard-rules.pro

# Retrofit does reflection on generic parameters. InnerClasses is required to use Signature and
# EnclosingMethod is required to use InnerClasses.
-keepattributes Signature, InnerClasses, EnclosingMethod

# Retrofit does reflection on method and parameter annotations.
-keepattributes RuntimeVisibleAnnotations, RuntimeVisibleParameterAnnotations

# Keep annotation default values (e.g., retrofit2.http.Field.encoded).
-keepattributes AnnotationDefault

# Retain service method parameters when optimizing.
-keepclassmembers,allowshrinking,allowobfuscation interface * {
    @retrofit2.http.* <methods>;
}

# Ignore annotation used for build tooling.
-dontwarn org.codehaus.mojo.animal_sniffer.IgnoreJRERequirement

# Ignore JSR 305 annotations for embedding nullability information.
-dontwarn javax.annotation.**

# Guarded by a NoClassDefFoundError try/catch and only used when on the classpath.
-dontwarn kotlin.Unit

# Top-level functions that can only be used by Kotlin.
-dontwarn retrofit2.KotlinExtensions
-dontwarn retrofit2.KotlinExtensions$*

# With R8 full mode, it sees no subtypes of Retrofit interfaces since they are created with a Proxy
# and replaces all potential values with null. Explicitly keeping the interfaces prevents this.
-if interface * { @retrofit2.http.* <methods>; }
-keep,allowobfuscation interface <1>

# Keep inherited services.
-if interface * { @retrofit2.http.* <methods>; }
-keep,allowobfuscation interface * extends <1>

# Keep generic signature of Call, Response (R8 full mode strips signatures from non-kept items).
-keep,allowobfuscation,allowshrinking interface retrofit2.Call
-keep,allowobfuscation,allowshrinking class retrofit2.Response

# With R8 full mode generic signatures are stripped for classes that are not
# kept. Suspend functions are wrapped in continuations where the type argument
# is used.
-keep,allowobfuscation,allowshrinking class kotlin.coroutines.Continuation

# https://github.com/naver/naveridlogin-sdk-android/issues/34
-keep public class com.navercorp.nid.** { *; }
-keep public class com.nhn.android.naverlogin.** { *; }
-keep class j$.util.** { *; }

Done!

iOS

Cocoapod

<your project root>ios/

pod install

This assumes that you've done the "Register and Configure Your App with Naver" step in the the Naver Login documentation for iOS site. (Note: you can skip "Step 2: Set up Your Development Environment").

After you've done that, find out what your Naver App Client ID is. You can find your Client ID, Client Secret, URL_SCHEME, in your Naver App's dashboard in the Naver developer.

<your project root>ios/Runner/Info.plist

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
				<!-- other codes -->
        <key>CFBundleURLTypes</key>
        <array>
            <dict>
                <key>CFBundleTypeRole</key>
                <string>Editor</string>
                <key>CFBundleURLSchemes</key>
                <array>
                    <string>[UrlScheme]</string>
                </array>
            </dict>
        </array>

        <key>LSApplicationQueriesSchemes</key>
        <array>
            <string>naversearchapp</string>
            <string>naversearchthirdlogin</string>
        </array>
        <key>naverServiceAppUrlScheme</key>
        <string>[UrlScheme]</string>
        <key>naverConsumerKey</key>
        <string>[ConsumerKey]</string>
        <key>naverConsumerSecret</key>
        <string>[ConsumerSecret]</string>
        <key>naverServiceAppName</key>
        <string>[ServiceAppName]</string>

        <!-- http allows configurations -->
        <key>NSAppTransportSecurity</key>
        <dict>
           <key>NSAllowsArbitraryLoads</key>
           <true/>
           <key>NSExceptionDomains</key>
           <dict>
              <key>naver.com</key>
              <dict>
                 <key>NSExceptionRequiresForwardSecrecy</key>
                 <false/>
                 <key>NSIncludesSubdomains</key>
                 <true/>
              </dict>
              <key>naver.net</key>
              <dict>
                 <key>NSExceptionRequiresForwardSecrecy</key>
                 <false/>
                 <key>NSIncludesSubdomains</key>
                 <true/>
              </dict>
           </dict>
        </dict>
    </dict>
</plist>

A sample of a complete Info.plist file can be found here.

Add the following code to log in using the Naver app.

object-c

<your project root>ios/Runner/AppDelegate.m

// Implemented when iOS 9.0 Less
- (BOOL)application:(UIApplication *)application openURL:(NSURL *)url sourceApplication:(NSString *)sourceApplication annotation:(id)annotation {
    return [[NaverThirdPartyLoginConnection getSharedInstance] application:application openURL:url sourceApplication:sourceApplication annotation:annotation];
}

// Implemented when iOS 9.0 higher

- (BOOL)application:(UIApplication *)app openURL:(NSURL *)url options:(NSDictionary<NSString *,id> *)options {
    return [[NaverThirdPartyLoginConnection getSharedInstance] application:app openURL:url options:options];
}

swift

<your project root>ios/Runner/AppDelegate.swift

import NaverThirdPartyLogin

override func application(_ app: UIApplication, open url: URL, options: [UIApplicationOpenURLOptionsKey : Any] = [:]) -> Bool {
    var applicationResult = false
    if (!applicationResult) {
       applicationResult = NaverThirdPartyLoginConnection.getSharedInstance().application(app, open: url, options: options)
    }
    // if you use other application url process, please add code here.
    
    if (!applicationResult) {
       applicationResult = super.application(app, open: url, options: options)
    }
    return applicationResult
}

** if you use xcode version is over 10 **

  1. When FlutterNaverLogin.logIn() doesn't return anything. if your Naver Social Login works in Android and ios(Naver app is not installed). Especially if you already face this error with modifing "AppDelegate.swift". Then you should check xcode version. Swift Compiler Error (Xcode): 'UIApplicationOpenURLOptionsKey' has been renamed to 'UIApplication.OpenURLOptionsKey'
import NaverThirdPartyLogin

override func application(_ app: UIApplication, open url: URL, options: [UIApplication.OpenURLOptionsKey : Any] = [:]) -> Bool {
    var applicationResult = false
    if (!applicationResult) {
       applicationResult = NaverThirdPartyLoginConnection.getSharedInstance().application(app, open: url, options: options)
    }
    // if you use other application url process, please add code here.
    
    if (!applicationResult) {
       applicationResult = super.application(app, open: url, options: options)
    }
    return applicationResult
}

How do I use it?

The library tries to closely match the native Android & iOS login SDK APIs where possible. For complete API documentation, just see the source code. Everything is documented there.

Since sample code is worth more than one page of documentation, here are the usual cases covered:

Getting the Naver acccount of a signed in user

NaverLoginResult res = await FlutterNaverLogin.logIn();
setState(() {
    name = res.account.name;
});

The account variable will now contain the following information:

final String nickname;
final String id;
final String name;
final String email;
final String gender;
final String age;
final String birthday;
final String birthyear;
final String profileImage;
final String mobile;
final String mobileE164;

Getting the Naver currentAccessToken of a signed in user

import 'package:flutter_naver_login/flutter_naver_login.dart';

NaverLoginResult res = await FlutterNaverLogin.logIn();
final NaverLoginResult result = await FlutterNaverLogin.logIn();
NaverAccessToken res = await FlutterNaverLogin.currentAccessToken;
setState(() {
   accesToken = res.accessToken;
   tokenType = res.tokenType;
});

ios issue

  1. CocoaPods could not find compatible versions for pod "naveridlogin-sdk-ios" Specs satisfying the naveridlogin-sdk-ios (~> 4.0.12) dependency were found, but they required a higher minimum deployment target.
    • runner target - required a higher deployment target 10.0.
  2. d: warning: directory not found for option '-L/project directory' ld: library not found for -lflutter_naver_login clang: error: linker command failed with exit code 1 (use -v to see invocation)
    • build - clean - commandRun: flutter run
  3. Showing All Messages: Multiple commands produce '/Users/yoonjaepark/dev/my_app/build/ios/Debug-iphonesimulator/Runner.app/Frameworks/Flutter.framework':
    • file - project settings - build system - legacy build system

Libraries

flutter_naver_login
interface/flutter_naver_login_method_channel
interface/flutter_naver_login_platform_interface
interface/types/channel_method
interface/utils/clock