An Android library that enhances the StrictMode reporting.
- Head-up Notification of StrictMode violations.
- Custom Actions that called when StrictMode violations is happend.
- Violation History Viewer that automatically installed.
In your build.gradle:
repositories {
jcenter()
}
dependencies {
debugCompile 'com.nshmura:strictmode-notifier:0.8.2'
releaseCompile 'com.nshmura:strictmode-notifier-no-op:0.8.2'
}In your Application class:
public class ExampleApplication extends Application {
@Override public void onCreate() {
super.onCreate();
if (BuildConfig.DEBUG) {
//setup this library
StrictModeNotifier.install(this);
//setup StrictMode.
//
// penaltyLog() should be called for strictmode-notifier
//
new Handler().post(new Runnable() {
@Override public void run() {
StrictMode.ThreadPolicy threadPolicy = new StrictMode.ThreadPolicy.Builder()
.detectAll()
.permitDiskReads()
.permitDiskWrites()
.penaltyLog() // Must!
.build();
StrictMode.setThreadPolicy(threadPolicy);
StrictMode.VmPolicy vmPolicy = new StrictMode.VmPolicy.Builder()
.detectAll()
.penaltyLog() // Must!
.build();
StrictMode.setVmPolicy(vmPolicy);
}
});
}
}
}strictmode-notifierstartslogcatcommand in backgound thread, and infinitely reads the log fromlogcat.- If StrictMode violation is happend, error logs is outputed.
strictmode-notifierreads that log vialogcat, and shows a notification of the violation.
You need to make sure that the customization happens only in debug build,
since the strictmode-notifier-no-op only contains the StrictModeNotifier class.
Make MyStrictMode class in debug build directory:
public class MyStrictMode {
public static void init(Context context) {
StrictModeNotifier
.install(context)
//... Customizing ...
//setup StrictMode.
//...
}
}Make MyStrictMode class in release build directory:
public class MyStrictMode {
public static void init(Context context) {
//no-op
}
}In your Application class:
public class ExampleApplication extends Application {
@Override public void onCreate() {
super.onCreate();
MyStrictMode.init(this);
}
}StrictModeNotifier
.install(context)
.setIgnoreAction(new NotifierConfig.IgnoreAction() {
@Override public boolean ignore(StrictModeViolation violation) {
// ex) ignore LEAKED_CLOSABLE_OBJECTS that contains android.foo.bar in stacktrace.
return violation.violationType == ViolationType.LEAKED_CLOSABLE_OBJECTS
&& violation.getStacktraceText().contains("android.foo.bar");
}
});StrictModeNotifier
.install(context)
.addCustomAction(new NotifierConfig.CustomAction() {
@Override public void onViolation(StrictModeViolation violation) {
//ex) Send messages into Slack
}
});StrictModeNotifier
.install(context)
.setHeadupEnabled(false)
.setDebugMode(true);Parsing following violations
- ActivityLeaks
- LeakedRegistrationObjects
- LeakedSqlLiteObjects
Inspired by square/leakcanary
Copyright (C) 2016 nshmura
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent