1. Wprowadzenie
Ostatnia aktualizacja: 3.02.2022 r.
Czego się nauczysz
- Jak utworzyć bardzo prosty komponent WebView na Androidzie
- Jak wysyłać zdarzenia WebView do Firebase
Czego potrzebujesz
- Projekt Firebase z wdrożonym pakietem SDK Analytics
- Android Studio w wersji 4.2 lub nowszej.
- Emulator Androida z Androidem 5.0 lub nowszym.
- Znajomość języka programowania Java.
- Znajomość języka programowania JavaScript.
2. Tworzenie prostego komponentu WebView na Androidzie
Dodawanie komponentu WebView w układzie aktywności
Aby dodać komponent WebView do aplikacji w układzie, dodaj ten kod do pliku XML układu aktywności:
<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout
xmlns:android="http://schemas.android.com/apk/res/android"
xmlns:app="http://schemas.android.com/apk/res-auto"
xmlns:tools="http://schemas.android.com/tools"
android:layout_width="match_parent"
android:layout_height="match_parent"
tools:context=".WebActivity"
>
<WebView
android:id="@+id/webview"
android:layout_width="match_parent"
android:layout_height="match_parent"
/>
</androidx.constraintlayout.widget.ConstraintLayout>;
Dodawanie komponentu WebView w narzędziu onCreate()
Aby wczytać stronę internetową w komponencie WebView, użyj funkcji loadUrl(). Komponent WebView powinien być tworzony dla działań czarnych. Na przykład zastosujemy go do metody onCreate :
public class WebActivity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_web);
// Navigate to site
myWebView.loadUrl("https://bittererhu.glitch.me");
}
}
Zanim to jednak zadziała, aplikacja musi mieć dostęp do internetu. Aby uzyskać dostęp do internetu, poproś o uprawnienie INTERNET w pliku manifestu. Przykład:
<uses-permission android:name="android.permission.INTERNET" />
To wszystko, czego potrzebujesz w przypadku podstawowego komponentu WebView wyświetlającego stronę internetową.
Używanie JavaScriptu w komponentach WebView
jeśli strona internetowa, którą chcesz wczytać w komponencie WebView, korzysta z JavaScriptu, musisz włączyć w komponencie WebView obsługę JavaScript. Po włączeniu JavaScriptu możesz też tworzyć interfejsy między kodem aplikacji a JavaScriptem.
JavaScript jest domyślnie wyłączony w komponentach WebView. Możesz go włączyć w WebSettings dołączonym do Twojego komponentu WebView. Możesz pobrać ustawienia WebSettings za pomocą metody getSettings(), a następnie włączyć JavaScript za pomocą metody setJavaScriptEnabled().
Przykład:
WebView myWebView = (WebView) findViewById(R.id.webview);
WebSettings webSettings = myWebView.getSettings();
webSettings.setJavaScriptEnabled(true);
Zaktualizowana aktywność :
public class WebActivity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_web);
WebView myWebView = (WebView) findViewById(R.id.webview);
if(myWebView != null) {
WebSettings webSettings = myWebView.getSettings();
webSettings.setJavaScriptEnabled(true);
}
// Navigate to site
myWebView.loadUrl("https://bittererhu.glitch.me");
}
}
3. Wdrażanie interfejsu połączonego z JavaScriptem
Moduł obsługi Javacript
Pierwszym krokiem podczas korzystania z Google Analytics w komponencie WebView jest utworzenie funkcji JavaScriptu, które będą przekazywać zdarzenia i właściwości użytkownika do kodu natywnego. Z przykładu poniżej dowiesz się, jak to zrobić w sposób zgodny z kodem natywnym zarówno na Androida, jak i na urządzenia Apple:
W tym przykładzie utworzyłem plik JavaScript o nazwie skrypt.js zawierający następujące elementy :
function logEvent(name, params) {
if (!name) {
return;
}
if (window.AnalyticsWebInterface) {
// Call Android interface
window.AnalyticsWebInterface.logEvent(name, JSON.stringify(params));
} else if (window.webkit
&& window.webkit.messageHandlers
&& window.webkit.messageHandlers.firebase) {
// Call iOS interface
var message = {
command: 'logEvent',
name: name,
parameters: params
};
window.webkit.messageHandlers.firebase.postMessage(message);
} else {
// No Android or iOS interface found
console.log("No native APIs found.");
}
}
function setUserProperty(name, value) {
if (!name || !value) {
return;
}
if (window.AnalyticsWebInterface) {
// Call Android interface
window.AnalyticsWebInterface.setUserProperty(name, value);
} else if (window.webkit
&& window.webkit.messageHandlers
&& window.webkit.messageHandlers.firebase) {
// Call iOS interface
var message = {
command: 'setUserProperty',
name: name,
value: value
};
window.webkit.messageHandlers.firebase.postMessage(message);
} else {
// No Android or iOS interface found
console.log("No native APIs found.");
}
}
Interfejs natywny
Aby wywołać natywny kod Androida z poziomu JavaScriptu, zaimplementuj klasę z metodami oznaczonymi @JavaScriptInterface. W poniższym przykładzie utworzyłem nową klasę Java o nazwie AnalyticsWebInterfcae.java:
public class AnalyticsWebInterface {
public static final String TAG = "AnalyticsWebInterface";
private FirebaseAnalytics mAnalytics;
public AnalyticsWebInterface(Context context) {
mAnalytics = FirebaseAnalytics.getInstance(context);
}
@JavascriptInterface
public void logEvent(String name, String jsonParams) {
LOGD("logEvent:" + name);
mAnalytics.logEvent(name, bundleFromJson(jsonParams));
}
@JavascriptInterface
public void setUserProperty(String name, String value) {
LOGD("setUserProperty:" + name);
mAnalytics.setUserProperty(name, value);
}
private void LOGD(String message) {
// Only log on debug builds, for privacy
if (BuildConfig.DEBUG) {
Log.d(TAG, message);
}
}
private Bundle bundleFromJson(String json) {
// ...
}
}
Once you have created the native interface, register it with your WebView so that it is visible to JavaScript code running in the WebView:
// Only add the JavaScriptInterface on API version JELLY_BEAN_MR1 and above, due to
// security concerns, see link below for more information:
// https://developer.android.com/reference/android/webkit/WebView.html#addJavascriptInterface(java.lang.Object,%20java.lang.String)
if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.JELLY_BEAN_MR1) {
mWebView.addJavascriptInterface(
new AnalyticsWebInterface(this), AnalyticsWebInterface.TAG);
} else {
Log.w(TAG, "Not adding JavaScriptInterface, API Version: " + Build.VERSION.SDK_INT);
}
Kod końcowy :
// [START analytics_web_interface]
public class AnalyticsWebInterface {
public static final String TAG = "AnalyticsWebInterface";
private FirebaseAnalytics mAnalytics;
public AnalyticsWebInterface(Context context) {
mAnalytics = FirebaseAnalytics.getInstance(context);
}
@JavascriptInterface
public void logEvent(String name, String jsonParams) {
LOGD("logEvent:" + name);
mAnalytics.logEvent(name, bundleFromJson(jsonParams));
}
@JavascriptInterface
public void setUserProperty(String name, String value) {
LOGD("setUserProperty:" + name);
mAnalytics.setUserProperty(name, value);
}
private void LOGD(String message) {
// Only log on debug builds, for privacy
if (BuildConfig.DEBUG) {
Log.d(TAG, message);
}
}
private Bundle bundleFromJson(String json) {
// [START_EXCLUDE]
if (TextUtils.isEmpty(json)) {
return new Bundle();
}
Bundle result = new Bundle();
try {
JSONObject jsonObject = new JSONObject(json);
Iterator<String> keys = jsonObject.keys();
while (keys.hasNext()) {
String key = keys.next();
Object value = jsonObject.get(key);
if (value instanceof String) {
result.putString(key, (String) value);
} else if (value instanceof Integer) {
result.putInt(key, (Integer) value);
} else if (value instanceof Double) {
result.putDouble(key, (Double) value);
} else {
Log.w(TAG, "Value for key " + key + " not one of [String, Integer, Double]");
}
}
} catch (JSONException e) {
Log.w(TAG, "Failed to parse JSON, returning empty Bundle.", e);
return new Bundle();
}
return result;
// [END_EXCLUDE]
}
Masz już skonfigurowany interfejs JavaScript , możesz więc zacząć wysyłać zdarzenia analityczne.
4. Wysyłanie zdarzeń za pomocą interfejsu
Jak widać, komponent WebView jest bardzo prosty, ponieważ zawiera 3 przyciski, które służą do rejestrowania zdarzenia, a drugi – do rejestrowania właściwości użytkownika :
Po kliknięciu przycisków nastąpi wywołanie mojego skryptu „script.js”. i wykonaj następujący kod :
document.getElementById("event1").addEventListener("click", function() {
console.log("event1");
logEvent("event1", { foo: "bar", baz: 123 });
});
document.getElementById("event2").addEventListener("click", function() {
console.log("event2");
logEvent("event2", { size: 123.456 });
});
document.getElementById("userprop").addEventListener("click", function() {
console.log("userprop");
setUserProperty("userprop", "custom_value");
});
Końcowy plik script.js :
/* If you're feeling fancy you can add interactivity
to your site with Javascript */
// prints "hi" in the browser's dev tools console
console.log("hi");
// [START log_event]
function logEvent(name, params) {
if (!name) {
return;
}
if (window.AnalyticsWebInterface) {
// Call Android interface
window.AnalyticsWebInterface.logEvent(name, JSON.stringify(params));
} else if (window.webkit
&& window.webkit.messageHandlers
&& window.webkit.messageHandlers.firebase) {
// Call iOS interface
var message = {
command: 'logEvent',
name: name,
parameters: params
};
window.webkit.messageHandlers.firebase.postMessage(message);
} else {
// No Android or iOS interface found
console.log("No native APIs found.");
}
}
// [END log_event]
// [START set_user_property]
function setUserProperty(name, value) {
if (!name || !value) {
return;
}
if (window.AnalyticsWebInterface) {
// Call Android interface
window.AnalyticsWebInterface.setUserProperty(name, value);
} else if (window.webkit
&& window.webkit.messageHandlers
&& window.webkit.messageHandlers.firebase) {
// Call iOS interface
var message = {
command: 'setUserProperty',
name: name,
value: value
};
window.webkit.messageHandlers.firebase.postMessage(message);
} else {
// No Android or iOS interface found
console.log("No native APIs found.");
}
}
// [END set_user_property]
document.getElementById("event1").addEventListener("click", function() {
console.log("event1");
logEvent("event1", { foo: "bar", baz: 123 });
});
document.getElementById("event2").addEventListener("click", function() {
console.log("event2");
logEvent("event2", { size: 123.456 });
});
document.getElementById("userprop").addEventListener("click", function() {
console.log("userprop");
setUserProperty("userprop", "custom_value");
});
To jest podstawowy sposób wysyłania zdarzeń do Analytics
5. Debugowanie zdarzeń WebView w Firebase
Debugowanie zdarzeń komponentu WebView w aplikacji działa tak samo jak debugowanie natywnej części pakietu SDK :
Aby włączyć tryb debugowania, użyj tych poleceń w konsoli Android Studio:
adb shell setprop debug.firebase.analytics.app package_name
Po zakończeniu możesz przetestować, jak działają zdarzenia WebView :
6. Gratulacje
Gratulacje. Udało Ci się utworzyć komponent WebView w aplikacji na Androida. Możesz wysyłać i mierzyć kluczowe zdarzenia ścieżki w aplikacji za pomocą komponentów WebView. Aby w pełni wykorzystać możliwości, warto też połączyć się z Google Ads i zaimportować te zdarzenia jako konwersje.
Wiesz już,
- Jak wysyłać do Firebase zdarzenia WebView
- Jak skonfigurować i utworzyć prosty komponent WebView na Androidzie