Giter VIP home page Giter VIP logo

basemodule's Introduction

Version:

basemodule

License API

basemodule是基于Android应用程序技术栈Jetpack封装的基础模块,旨在快速构建应用,提升开发效率。


Gradle

Add a dependency code to your module's build.gradle file.

Step 1. Add the JitPack repository to your build file
allprojects {
		repositories {
			...
			maven { url 'https://jitpack.io' }
		}
	}
	Step 2. Add the dependency
dependencies {
	        implementation 'com.github.by8023hxy:basemodule:Tag'
	}

技术栈和开源库

  • Minimum SDK level 26

  • Kotlin based + Coroutines+Flow for asynchronous.

  • Koin 依赖注入框架

  • JetPack

    • LiveData - notify domain layer data to views.
    • Lifecycle - dispose of observing data when lifecycle state changes.
    • ViewModel - UI related data holder, lifecycle aware.
  • Architecture

    • MVVM Architecture (View - DataBinding - ViewModel - Model)
    • Repository pattern 数据仓库
  • Retrofit2 & OkHttp3 - construct the REST APIs and paging network data.

  • Glide (https://github.com/florent37/GlidePalette) - loading images.

  • Gson 操作java对象和json数据之间的相互转换

Architecture

BasicFramework is based on MVVM architecture and a repository pattern.

architecture

Usage

Activity

abstract class DataBindingActivity : AppCompatActivity() {

    protected abstract fun getDataBindingConfig(): DataBindingConfig

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        initDataBinding()
        setObserve()
        initView()
        initData()
     }
   }

class MainActivity : DataBindingActivity() {

    private val mainViewModel: MainViewModel by viewModel()

    private val dialog: ProgressDialogFragment by lazy { ProgressDialogFragment() }
    override fun getDataBindingConfig(): DataBindingConfig {
        return DataBindingConfig(R.layout.activity_main,BR.vm,mainViewModel)
            .addBindingParam(BR.adapter,DemoAdapter())
    }

    override fun initView() {
        mainViewModel.apply {
            getBannerList()
        }
    }

    override fun initData() {

    }

    override fun setObserve() {
        mainViewModel.isLoading().observe(this, {
            operateDialog(it)
        })
      }
    }

Repository

inline fun <T> flowScope(crossinline request: suspend () -> BaseResponse<T>): LiveData<RequestState<T>> {
    return flow {
        "flowScope onThread=${Thread.currentThread().name}".logD(TAG)
        val response = request()
        "flowScope response=${Gson().toJson(response)}".logD(TAG)
        if (response.isSuccess()) {
            emit(RequestState.Success(response.getResponseData()))
        } else {
            emit(
                RequestState.Error(
                    ApiException(
                        response.getResponseMsg(),
                        response.getResponseCode()
                    )
                )
            )
        }
    }.onStart {
        emit(RequestState.Loading)
    }.catch {
        val apiException = getApiException(it)
        "flowScope exception==${Gson().toJson(it)}".logE()
        emit(RequestState.Error(apiException))
    }.asLiveData()
}

class AppRepository(private val remoteService: RemoteService) {
    suspend fun getBannerList(id:String) = flowScope { remoteService.getBanner() }
}

ViewModel

class MainViewModel(private val repository: AppRepository) : LiveCoroutinesViewModel() {

    val banner: ObservableField<List<BannerInfo>> = ObservableField()

    private val _bannerList = MutableLiveData<String>()

    val bannerList=_bannerList.switchMap {
        launchOnViewModelScope { repository.getBannerList() }
    }

    fun getBannerList(id:String){
        _bannerList.value=id
    }

}

Koin in Application

class MyApp : BaseApp() {
    companion object {
        @JvmStatic
        lateinit var CONTEXT: BaseApp

        @JvmStatic
        val shareViewModel: ShareViewModel by lazy { ShareViewModel() }
    }

    override fun onCreate() {
        super.onCreate()
        "MyApp onCreate!!!".logD()
        CONTEXT = this
        MMKV.initialize(this)
        startKoin {
            androidLogger(Level.NONE)
            androidContext(this@MyApp)
            androidFileProperties()
            modules(applicationModules)
        }
    }
}

Koin module

val viewModelModule = module {
    viewModel { MainViewModel(get()) }
}

val repositoryModule = module {
    single { AppRepository(get()) }
}

val httpModule = module {
     single<OkHttpClient> {
           OkHttpClient.Builder()
               .cache(Cache(File(MyApp.CONTEXT.cacheDir, "okhttp_cache"), 1024 * 1024 * 256L))
               .addInterceptor(CacheInterceptor())
               .addInterceptor(HttpLoggingInterceptor { message -> message.logD("MyHttpLog") }.apply {
                   this.level = HttpLoggingInterceptor.Level.BODY
               })    // 日志拦截器
               .addNetworkInterceptor(CacheNetworkInterceptor())
               .connectTimeout(BaseConstant.HTTP_CONNECT_TIME, TimeUnit.SECONDS)
               .readTimeout(BaseConstant.HTTP_READ_TIME, TimeUnit.SECONDS)
               .writeTimeout(BaseConstant.HTTP_WRITE_TIME, TimeUnit.SECONDS)
               .build()
       }
    single<RemoteService> {
        Retrofit.Builder()
            .client(get())
            .addConverterFactory(GsonConverterFactory.create(GsonBuilder().create()))
            .addCallAdapterFactory(CoroutineCallAdapterFactory())
            .baseUrl(RemoteService.BASE_URL)
            .build().create(RemoteService::class.java)
    }
}

Find this library useful? ❤️

Support it by joining basemodule for this repository. ⭐
And follow me for my next creations! 🤩

Thanks to

AndroidX

Jetpack MVVM

UnPeek-LiveData

Jetpack-MVVM-Best-Practice

AndroidUtilCodeKTX

Bindables

basemodule's People

Contributors

by8023hxy avatar

Stargazers

阿祥 avatar Görkem KARA avatar  avatar Yi avatar  avatar  avatar  avatar 无伤大雅的你呀 avatar

Watchers

 avatar

basemodule's Issues

License violation.

Hey, I found your library and looks great.
But, your project and module looks violated every licenses...?
Pokedex, Sandwich and WhatIf using Apache 2.0 license. http://www.apache.org/licenses/LICENSE-2.0.
You removed every license and copy-pasted just from his projects...
I think this kind of violating is not good effect for open source environment....
Or just use his dependencies in your project. But why did copy-pasted and removed all licenses???

Read the below license and It seems you must study first open source license rule instead of copy-paste coding skills. :)

Apache License

Version 2.0, January 2004

http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.

"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:

You must give any other recipients of the Work or Derivative Works a copy of this License; and
You must cause any modified files to carry prominent notices stating that You changed the files; and
You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.

You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.