Skip to content

Commit f07d63a

Browse files
xgfd3xgfd3
authored
Feat/code style android (#366)
* [Android]add check style config. * [Android]update check style config. * [Android]update codes with checked style.
1 parent 53dd609 commit f07d63a

File tree

154 files changed

+7853
-3804
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

154 files changed

+7853
-3804
lines changed

‎.githooks/pre-commit

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
#!/bin/sh
2+
#
3+
# An example hook script to verify what is about to be committed.
4+
# Called by "git commit" with no arguments. The hook should
5+
# exit with non-zero status after issuing an appropriate message if
6+
# it wants to stop the commit.
7+
#
8+
# To enable this hook, rename this file to "pre-commit".
9+
10+
if git rev-parse --verify HEAD >/dev/null 2>&1
11+
then
12+
against=HEAD
13+
else
14+
# Initial commit: diff against an empty tree object
15+
against=$(git hash-object -t tree /dev/null)
16+
fi
17+
18+
SCRIPT_DIR=$(dirname "$0")
19+
SCRIPT_ABS_PATH=`cd "$SCRIPT_DIR"; pwd`
20+
21+
22+
ANDROID_DIFF_FILES=`git diff --cached --name-only --diff-filter=ACM -- '*' | grep 'Android'`
23+
if [[ "$ANDROID_DIFF_FILES" != "" ]]
24+
then
25+
cd Android/APIExample
26+
echo "precommit >> current paht = $(pwd), diff files = $ANDROID_DIFF_FILES"
27+
./gradlew -Dorg.gradle.project.commit_diff_files="$ANDROID_DIFF_FILES" checkstyle detekt
28+
if [ $? -eq 0 ]; then
29+
echo "precommit >> checkstyle detekt OK."
30+
else
31+
echo "precommit >> checkstyle detekt Failed."
32+
exit 1
33+
fi
34+
else
35+
echo "precommit >> No changing android files."
36+
fi
37+
38+

‎Android/APIExample/app/build.gradle

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
apply plugin: 'com.android.application'
22
apply plugin: 'kotlin-android'
3+
apply from: "${rootDir.absolutePath}/git-hooks.gradle"
34

45
def localSdkPath= "${rootProject.projectDir.absolutePath}/../../sdk"
56

‎Android/APIExample/app/src/main/java/io/agora/api/example/MainApplication.java

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@
1010
import io.agora.api.example.common.model.GlobalSettings;
1111
import io.agora.api.example.utils.ClassUtils;
1212

13+
/**
14+
* The type Main application.
15+
*/
1316
public class MainApplication extends Application {
1417

1518
private GlobalSettings globalSettings;
@@ -34,14 +37,18 @@ private void initExamples() {
3437
}
3538
}
3639
Examples.sortItem();
37-
}
38-
catch (Exception e) {
40+
} catch (Exception e) {
3941
e.printStackTrace();
4042
}
4143
}
4244

45+
/**
46+
* Gets global settings.
47+
*
48+
* @return the global settings
49+
*/
4350
public GlobalSettings getGlobalSettings() {
44-
if(globalSettings == null){
51+
if (globalSettings == null) {
4552
globalSettings = new GlobalSettings();
4653
}
4754
return globalSettings;

‎Android/APIExample/app/src/main/java/io/agora/api/example/MainFragment.java

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,9 @@
3131
* interface.
3232
*/
3333
public class MainFragment extends Fragment {
34-
// TODO: Customize parameter argument names
34+
// Customize parameter argument names
3535
private static final String ARG_COLUMN_COUNT = "column-count";
36-
// TODO: Customize parameters
36+
// Customize parameters
3737
private int mColumnCount = 1;
3838
private OnListFragmentInteractionListener mListener;
3939

@@ -44,7 +44,12 @@ public class MainFragment extends Fragment {
4444
public MainFragment() {
4545
}
4646

47-
// TODO: Customize parameter initialization
47+
/**
48+
* New instance main fragment.
49+
*
50+
* @param columnCount the column count
51+
* @return the main fragment
52+
*/
4853
@SuppressWarnings("unused")
4954
public static MainFragment newInstance(int columnCount) {
5055
MainFragment fragment = new MainFragment();
@@ -114,7 +119,11 @@ public void onDetach() {
114119
* >Communicating with Other Fragments</a> for more information.
115120
*/
116121
public interface OnListFragmentInteractionListener {
117-
// TODO: Update argument type and name
122+
/**
123+
* Update argument type and name.
124+
*
125+
* @param item the item
126+
*/
118127
void onListFragmentInteraction(Example item);
119128
}
120129

‎Android/APIExample/app/src/main/java/io/agora/api/example/ReadyFragment.java

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ public View onCreateView(@NonNull LayoutInflater inflater, @Nullable ViewGroup c
5454
public void onViewCreated(@NonNull View view, @Nullable Bundle savedInstanceState) {
5555
super.onViewCreated(view, savedInstanceState);
5656
ActionBar actionBar = ((AppCompatActivity) getActivity()).getSupportActionBar();
57-
if(actionBar != null){
57+
if (actionBar != null) {
5858
actionBar.setTitle(exampleBean.getName());
5959
actionBar.setHomeButtonEnabled(true);
6060
actionBar.setDisplayHomeAsUpEnabled(true);
@@ -106,8 +106,7 @@ private void runOnPermissionGranted(@NonNull Runnable runnable) {
106106
// Request permission
107107
AndPermission.with(this).runtime().permission(
108108
permissionArray
109-
).onGranted(permissions ->
110-
{
109+
).onGranted(permissions -> {
111110
// Permissions Granted
112111
runnable.run();
113112
}).start();

‎Android/APIExample/app/src/main/java/io/agora/api/example/SettingActivity.java

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
/**
1818
* @author cjw
1919
*/
20-
public class SettingActivity extends AppCompatActivity{
20+
public class SettingActivity extends AppCompatActivity {
2121
private static final String TAG = SettingActivity.class.getSimpleName();
2222

2323
private ActivitySettingLayoutBinding mBinding;
@@ -31,24 +31,24 @@ protected void onCreate(@Nullable Bundle savedInstanceState) {
3131
mBinding.sdkVersion.setText(String.format(getString(R.string.sdkversion1), RtcEngine.getSdkVersion()));
3232
String[] mItems = getResources().getStringArray(R.array.orientations);
3333
String[] labels = new String[mItems.length];
34-
for(int i = 0;i<mItems.length;i++){
35-
int resId = getResources().getIdentifier( mItems[i], "string", getPackageName() );
34+
for (int i = 0; i < mItems.length; i++) {
35+
int resId = getResources().getIdentifier(mItems[i], "string", getPackageName());
3636
labels[i] = getString(resId);
3737
}
38-
ArrayAdapter<String> arrayAdapter =new ArrayAdapter<String>(this,android.R.layout.simple_spinner_dropdown_item, labels);
38+
ArrayAdapter<String> arrayAdapter = new ArrayAdapter<String>(this, android.R.layout.simple_spinner_dropdown_item, labels);
3939
mBinding.orientationSpinner.setAdapter(arrayAdapter);
4040
fetchGlobalSettings();
4141
}
4242

43-
private void fetchGlobalSettings(){
44-
GlobalSettings globalSettings = ((MainApplication)getApplication()).getGlobalSettings();
43+
private void fetchGlobalSettings() {
44+
GlobalSettings globalSettings = ((MainApplication) getApplication()).getGlobalSettings();
4545

4646
String[] mItems = getResources().getStringArray(R.array.orientations);
4747
String selectedItem = globalSettings.getVideoEncodingOrientation();
4848
int i = 0;
49-
if(selectedItem!=null){
50-
for(String item : mItems){
51-
if(selectedItem.equals(item)){
49+
if (selectedItem != null) {
50+
for (String item : mItems) {
51+
if (selectedItem.equals(item)) {
5252
break;
5353
}
5454
i++;
@@ -58,9 +58,9 @@ private void fetchGlobalSettings(){
5858
mItems = getResources().getStringArray(R.array.fps);
5959
selectedItem = globalSettings.getVideoEncodingFrameRate();
6060
i = 0;
61-
if(selectedItem!=null){
62-
for(String item : mItems){
63-
if(selectedItem.equals(item)){
61+
if (selectedItem != null) {
62+
for (String item : mItems) {
63+
if (selectedItem.equals(item)) {
6464
break;
6565
}
6666
i++;
@@ -70,9 +70,9 @@ private void fetchGlobalSettings(){
7070
mItems = getResources().getStringArray(R.array.dimensions);
7171
selectedItem = globalSettings.getVideoEncodingDimension();
7272
i = 0;
73-
if(selectedItem!=null){
74-
for(String item : mItems){
75-
if(selectedItem.equals(item)){
73+
if (selectedItem != null) {
74+
for (String item : mItems) {
75+
if (selectedItem.equals(item)) {
7676
break;
7777
}
7878
i++;
@@ -82,9 +82,9 @@ private void fetchGlobalSettings(){
8282
mItems = getResources().getStringArray(R.array.areaCode);
8383
selectedItem = globalSettings.getAreaCodeStr();
8484
i = 0;
85-
if(selectedItem!=null){
86-
for(String item : mItems){
87-
if(selectedItem.equals(item)){
85+
if (selectedItem != null) {
86+
for (String item : mItems) {
87+
if (selectedItem.equals(item)) {
8888
break;
8989
}
9090
i++;
@@ -111,7 +111,7 @@ public boolean onCreateOptionsMenu(@NonNull Menu menu) {
111111
@Override
112112
public boolean onOptionsItemSelected(MenuItem item) {
113113
if (item.getItemId() == saveMenu.getItemId()) {
114-
GlobalSettings globalSettings = ((MainApplication)getApplication()).getGlobalSettings();
114+
GlobalSettings globalSettings = ((MainApplication) getApplication()).getGlobalSettings();
115115
globalSettings.privateCloudIp = mBinding.privateCloudLayout.etIpAddress.getText().toString();
116116
globalSettings.privateCloudLogReportEnable = mBinding.privateCloudLayout.swLogReport.isChecked();
117117
globalSettings.privateCloudLogServerDomain = mBinding.privateCloudLayout.etLogServerDomain.getText().toString();

‎Android/APIExample/app/src/main/java/io/agora/api/example/annotation/Example.java

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
package io.agora.api.example.annotation;
22

3-
import android.os.Parcelable;
4-
5-
import java.io.Serializable;
63
import java.lang.annotation.ElementType;
74
import java.lang.annotation.Retention;
85
import java.lang.annotation.RetentionPolicy;

‎Android/APIExample/app/src/main/java/io/agora/api/example/common/BaseBrowserFragment.java

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,9 @@
3838
import io.agora.api.example.R;
3939
import io.agora.api.example.databinding.FragmentBaseBrowserBinding;
4040

41+
/**
42+
* The type Base browser fragment.
43+
*/
4144
public abstract class BaseBrowserFragment extends BaseFragment {
4245

4346
private FragmentBaseBrowserBinding mBinding;
@@ -122,7 +125,7 @@ public void handleOnBackPressed() {
122125
// 不使用缓存，只从网络获取数据
123126
// LOAD_CACHE_ONLY:
124127
// 不使用网络，只读取本地缓存数据
125-
webSettings.setCacheMode(WebSettings.LOAD_NO_CACHE);// 设置缓存模式
128+
webSettings.setCacheMode(WebSettings.LOAD_NO_CACHE); // 设置缓存模式
126129

127130

128131
// js 相关
@@ -153,7 +156,7 @@ public void handleOnBackPressed() {
153156
// 支持同时打开https和http
154157
webSettings.setMixedContentMode(WebSettings.MIXED_CONTENT_ALWAYS_ALLOW);
155158

156-
mWebView.setWebChromeClient(new WebChromeClient(){
159+
mWebView.setWebChromeClient(new WebChromeClient() {
157160

158161
@Override
159162
public boolean onConsoleMessage(ConsoleMessage consoleMessage) {
@@ -175,7 +178,7 @@ public boolean onJsAlert(WebView view, String url, String message, JsResult resu
175178

176179
@Override
177180
public boolean shouldOverrideUrlLoading(WebView view, WebResourceRequest request) {
178-
if(!request.getUrl().toString().equals(getBrowserUrl())){
181+
if (!request.getUrl().toString().equals(getBrowserUrl())) {
179182
openWithDefaultBrowser(request.getUrl().toString());
180183
return true;
181184
}
@@ -212,7 +215,7 @@ public void onReceivedError(WebView view, WebResourceRequest request, WebResourc
212215
mWebView.setWebContentsDebuggingEnabled(true);
213216
}
214217

215-
private void releaseWebView(){
218+
private void releaseWebView() {
216219
try {
217220
Field sConfigCallback = Class.forName("android.webkit.BrowserFrame").getDeclaredField("sConfigCallback");
218221
if (sConfigCallback != null) {
@@ -261,6 +264,11 @@ private void openWithDefaultBrowser(String url) {
261264
startActivity(intent);
262265
}
263266

267+
/**
268+
* Gets browser url.
269+
*
270+
* @return the browser url
271+
*/
264272
protected abstract String getBrowserUrl();
265273

266274
}

0 commit comments

Comments
 (0)