├── .gitignore ├── LICENSE.md ├── README.md ├── app ├── .gitignore ├── build.gradle ├── proguard-rules.pro └── src │ └── main │ ├── AndroidManifest.xml │ ├── java │ └── com │ │ └── lazygeniouz │ │ └── filecompat │ │ └── example │ │ ├── MainActivity.kt │ │ └── performance │ │ ├── DirectoryPerformance.kt │ │ ├── FilesPerformance.kt │ │ └── Performance.kt │ └── res │ ├── drawable-v24 │ └── ic_launcher_foreground.xml │ ├── drawable │ └── ic_launcher_background.xml │ ├── layout │ └── activity_main.xml │ ├── mipmap-anydpi-v26 │ ├── ic_launcher.xml │ └── ic_launcher_round.xml │ ├── mipmap-hdpi │ ├── ic_launcher.webp │ └── ic_launcher_round.webp │ ├── mipmap-mdpi │ ├── ic_launcher.webp │ └── ic_launcher_round.webp │ ├── mipmap-xhdpi │ ├── ic_launcher.webp │ └── ic_launcher_round.webp │ ├── mipmap-xxhdpi │ ├── ic_launcher.webp │ └── ic_launcher_round.webp │ ├── mipmap-xxxhdpi │ ├── ic_launcher.webp │ └── ic_launcher_round.webp │ └── values │ ├── colors.xml │ ├── strings.xml │ └── themes.xml ├── build.gradle ├── dfc ├── .gitignore ├── build.gradle ├── proguard-rules.pro └── src │ └── main │ ├── AndroidManifest.xml │ └── java │ └── com │ └── lazygeniouz │ └── dfc │ ├── controller │ └── DocumentController.kt │ ├── file │ ├── DocumentFileCompat.kt │ ├── SerializedFile.kt │ └── internals │ │ ├── RawDocumentFileCompat.kt │ │ ├── SingleDocumentFileCompat.kt │ │ └── TreeDocumentFileCompat.kt │ ├── logger │ └── ErrorLogger.kt │ └── resolver │ └── ResolverCompat.kt ├── gradle.properties ├── gradlew ├── gradlew.bat ├── screenshots ├── filecompat_directory_perf.jpeg └── filecompat_file_perf.jpeg └── settings.gradle /.gitignore: -------------------------------------------------------------------------------- 1 | *.iml 2 | *.txt 3 | *.sh 4 | .DS_Store 5 | 6 | .idea 7 | build 8 | gradle 9 | .gradle 10 | local.properties 11 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # DocumentFileCompat 2 | 3 | A faster alternative to AndroidX's DocumentFile. 4 | 5 | ### The Problem with DocumentFile 6 | 7 | It is horribly slow!\ 8 | For **almost** every method, there is a query to **ContentResolver**. 9 | 10 | The most common one is `DocumentFile.findFile()`, `DocumentFile.getName()` and other is building a 11 | Custom Data Model with multiple parameters.\ 12 | This can take like a horrible amount of time. 13 | 14 | ### Solution 15 | 16 | `DocumentFileCompat` is a drop-in replacement which gathers relevant parameters when querying for 17 | files.\ 18 | The performance can sometimes peak to 2x or quite higher, depending on the size of the folder. 19 | 20 | Check the screenshots below: 21 | 22 | [](/screenshots/filecompat_directory_perf.jpeg) 23 |       24 | [](/screenshots/filecompat_file_perf.jpeg) 25 | 26 | **48 whopping seconds for directory listing compared to 3.5!** (Obviously, No competition with the 27 | Native File API).\ 28 | Also extracting file information does not take that much time but the improvement is still 29 | significant. 30 | 31 | **Note:** `DocumentFileCompat` is something that I used internally for some projects & therefore I 32 | didn't do much of file manipulation with it (only delete files) and therefore this API does 33 | not offer too much out of the box.\ 34 | This is now a completely usable alternative to `DocumentFile`. 35 | 36 | ### Installation 37 | 38 | #### Gradle 39 | 40 | ```gradle 41 | dependencies { 42 | implementation "com.lazygeniouz:dfc:$latest_version" 43 | } 44 | ``` 45 | 46 | #### Maven 47 | 48 | ```xml 49 | 50 | 51 | com.lazygeniouz 52 | dfc 53 | $latest_version 54 | aar 55 | 56 | ``` 57 | 58 | ### Usage 59 | 60 | Almost all of the methods & getters are identical to `DocumentFile`, you'll just have to replace the 61 | imports.\ 62 | Additional methods like `copyTo(destination: Uri)` & `copyFrom(source: Uri)` are added as well. 63 | 64 | #### Reference: 65 | 66 | 1. https://stackoverflow.com/a/42187419/6819340 67 | 2. https://stackoverflow.com/a/63466997/6819340 68 | 69 | ### Issues & Suggestions 70 | 71 | Create a new issue if you experience any problem or have any suggestions.\ 72 | I'll appreciate if you create a PR as well (if possible). 73 | 74 | Finally, don't forget to ⭐️ the library! :) -------------------------------------------------------------------------------- /app/.gitignore: -------------------------------------------------------------------------------- 1 | /build -------------------------------------------------------------------------------- /app/build.gradle: -------------------------------------------------------------------------------- 1 | plugins { 2 | id 'com.android.application' 3 | id 'kotlin-android' 4 | } 5 | 6 | android { 7 | compileSdk 33 8 | namespace 'com.lazygeniouz.filecompat.example' 9 | 10 | defaultConfig { 11 | applicationId "com.lazygeniouz.filecompat.example" 12 | minSdk 21 13 | targetSdk 33 14 | versionCode 1 15 | versionName "1.0" 16 | 17 | testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner" 18 | } 19 | 20 | buildTypes { 21 | release { 22 | minifyEnabled false 23 | proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro' 24 | } 25 | } 26 | 27 | compileOptions { 28 | sourceCompatibility JavaVersion.VERSION_1_8 29 | targetCompatibility JavaVersion.VERSION_1_8 30 | } 31 | 32 | kotlinOptions { 33 | jvmTarget = '1.8' 34 | freeCompilerArgs += "-Xopt-in=kotlin.RequiresOptIn" 35 | } 36 | } 37 | 38 | dependencies { 39 | implementation project(':dfc') 40 | 41 | implementation 'androidx.appcompat:appcompat:1.6.0' 42 | implementation 'androidx.activity:activity-ktx:1.6.1' 43 | implementation 'com.google.android.material:material:1.7.0' 44 | } -------------------------------------------------------------------------------- /app/proguard-rules.pro: -------------------------------------------------------------------------------- 1 | # Add project specific ProGuard rules here. 2 | # You can control the set of applied configuration files using the 3 | # proguardFiles setting in build.gradle. 4 | # 5 | # For more details, see 6 | # http://developer.android.com/guide/developing/tools/proguard.html 7 | 8 | # If your project uses WebView with JS, uncomment the following 9 | # and specify the fully qualified class name to the JavaScript interface 10 | # class: 11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview { 12 | # public *; 13 | #} 14 | 15 | # Uncomment this to preserve the line number information for 16 | # debugging stack traces. 17 | #-keepattributes SourceFile,LineNumberTable 18 | 19 | # If you keep the line number information, uncomment this to 20 | # hide the original source file name. 21 | #-renamesourcefileattribute SourceFile -------------------------------------------------------------------------------- /app/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 5 | 8 | 9 | 10 | 11 | 12 | 13 | 20 | 21 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | -------------------------------------------------------------------------------- /app/src/main/java/com/lazygeniouz/filecompat/example/MainActivity.kt: -------------------------------------------------------------------------------- 1 | package com.lazygeniouz.filecompat.example 2 | 3 | import android.annotation.SuppressLint 4 | import android.app.Activity 5 | import android.content.Context 6 | import android.content.Intent 7 | import android.os.Build.VERSION.SDK_INT 8 | import android.os.Bundle 9 | import android.os.storage.StorageManager 10 | import android.widget.Button 11 | import android.widget.ProgressBar 12 | import android.widget.TextView 13 | import androidx.activity.result.contract.ActivityResultContracts 14 | import androidx.appcompat.app.AppCompatActivity 15 | import androidx.core.view.isVisible 16 | import androidx.lifecycle.lifecycleScope 17 | import com.lazygeniouz.filecompat.example.performance.Performance 18 | import kotlinx.coroutines.Dispatchers 19 | import kotlinx.coroutines.launch 20 | import kotlinx.coroutines.withContext 21 | 22 | class MainActivity : AppCompatActivity(R.layout.activity_main) { 23 | 24 | private lateinit var buttonDir: Button 25 | private lateinit var buttonFile: Button 26 | 27 | private lateinit var textView: TextView 28 | private lateinit var progress: ProgressBar 29 | 30 | private val folderResultLauncher = 31 | registerForActivityResult(ActivityResultContracts.StartActivityForResult()) { result -> 32 | if (result.resultCode == Activity.RESULT_OK) { 33 | val documentUri = result.data?.data 34 | if (documentUri != null) { 35 | textView.text = "" 36 | 37 | lifecycleScope.launch { 38 | progress.isVisible = true 39 | buttonDir.isVisible = false 40 | buttonFile.isVisible = false 41 | val performanceResult = withContext(Dispatchers.IO) { 42 | Performance.calculateDirectoryPerformance( 43 | this@MainActivity, documentUri 44 | ) 45 | } 46 | 47 | progress.isVisible = false 48 | buttonDir.isVisible = true 49 | buttonFile.isVisible = true 50 | textView.text = performanceResult 51 | } 52 | } 53 | } 54 | } 55 | 56 | 57 | @SuppressLint("SetTextI18n") 58 | private val fileResultLauncher = 59 | registerForActivityResult(ActivityResultContracts.StartActivityForResult()) { result -> 60 | if (result.resultCode == Activity.RESULT_OK) { 61 | val documentUri = result.data?.data 62 | if (documentUri != null) { 63 | textView.text = "" 64 | 65 | lifecycleScope.launch { 66 | val performance = withContext(Dispatchers.IO) { 67 | Performance.calculateFilesPerformance( 68 | this@MainActivity, documentUri 69 | ) 70 | } 71 | 72 | textView.text = performance 73 | } 74 | } 75 | } 76 | } 77 | 78 | override fun onCreate(savedInstanceState: Bundle?) { 79 | super.onCreate(savedInstanceState) 80 | 81 | buttonDir = findViewById(R.id.buttonDir) 82 | buttonFile = findViewById(R.id.buttonFile) 83 | textView = findViewById(R.id.fileNames) 84 | progress = findViewById(R.id.progress) 85 | 86 | buttonDir.setOnClickListener { 87 | folderResultLauncher.launch(getStorageIntent()) 88 | } 89 | 90 | buttonFile.setOnClickListener { 91 | fileResultLauncher.launch(getStorageIntent(true)) 92 | } 93 | } 94 | 95 | private fun getStorageIntent(single: Boolean = false): Intent { 96 | return if (single) Intent(Intent.ACTION_GET_CONTENT).setType("*/*") else { 97 | if (SDK_INT >= 30) { 98 | val storageManager = getSystemService(Context.STORAGE_SERVICE) as StorageManager 99 | storageManager.primaryStorageVolume.createOpenDocumentTreeIntent() 100 | } else Intent(Intent.ACTION_OPEN_DOCUMENT_TREE) 101 | } 102 | } 103 | 104 | @Suppress("override_deprecation") 105 | // this is just a sample app, ignore this. 106 | override fun onBackPressed() = finishAffinity() 107 | } -------------------------------------------------------------------------------- /app/src/main/java/com/lazygeniouz/filecompat/example/performance/DirectoryPerformance.kt: -------------------------------------------------------------------------------- 1 | package com.lazygeniouz.filecompat.example.performance 2 | 3 | import android.content.Context 4 | import android.net.Uri 5 | import android.os.Build 6 | import android.os.Environment 7 | import androidx.documentfile.provider.DocumentFile 8 | import com.lazygeniouz.dfc.file.DocumentFileCompat 9 | import com.lazygeniouz.filecompat.example.performance.Performance.measureTimeSeconds 10 | import java.io.File 11 | 12 | object DirectoryPerformance { 13 | 14 | fun calculateDirectorySidePerformance(context: Context, uri: Uri): String { 15 | var results = "" 16 | results += calculateNativeFilePerformance(uri) + "\n\n" 17 | results += calculateRawFileCompatPerformance(context, uri) + "\n\n" 18 | 19 | results += "=".repeat(48).plus("\n\n") 20 | results += calculateDocumentFileCompatPerformance(context, uri) + "\n" 21 | results += calculateDocumentFilePerformance(context, uri) + "\n\n" 22 | 23 | results += "=".repeat(48).plus("\n\n") 24 | results += "Fetching only Uris will always be faster (after File)" + "\nBut try fetching the Documents' Names.\n\n" 25 | results += calculateDocumentFileCompatPerformanceWithName(context, uri) + "\n" 26 | results += calculateDocumentFilePerformanceOnlyUri(context, uri) + "\n" 27 | results += calculateDocumentFilePerformanceWithName(context, uri) 28 | return results 29 | } 30 | 31 | 32 | // Nothing beats this. 33 | // This test also requires the File Access Permission 34 | private fun calculateNativeFilePerformance(uri: Uri): String { 35 | return if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R) { 36 | if (Environment.isExternalStorageManager()) { 37 | runFilesPerformance(uri) 38 | } else { 39 | "Android R+ requires All Files Access for this test to run." 40 | } 41 | } else { 42 | runFilesPerformance(uri) 43 | } 44 | } 45 | 46 | // This test also requires the File Access Permission. 47 | // Comes Second to the Native File API due to building internal objects. 48 | private fun calculateRawFileCompatPerformance(context: Context, uri: Uri): String { 49 | return if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.R) { 50 | if (Environment.isExternalStorageManager()) { 51 | runFilesCompatPerformance(context, uri) 52 | } else { 53 | "Android R+ requires All Files Access for this test to run." 54 | } 55 | } else { 56 | runFilesCompatPerformance(context, uri) 57 | } 58 | } 59 | 60 | private fun runFilesPerformance(uri: Uri): String { 61 | var size: Int = -1 62 | measureTimeSeconds { 63 | // If the paths file for tests, just hardcode with a fixed directory. 64 | val formattedPath = Performance.getUsablePath(uri) 65 | val files = File(Environment.getExternalStorageDirectory(), formattedPath).listFiles() 66 | size = files?.size ?: -1 67 | }.also { time -> 68 | val message = "Folder has $size items.\nNative File Performance = ${time}s" 69 | return (message) 70 | } 71 | } 72 | 73 | private fun runFilesCompatPerformance(context: Context, uri: Uri): String { 74 | var size: Int = -1 75 | measureTimeSeconds { 76 | // If the paths file for tests, just hardcode with a fixed directory. 77 | val formattedPath = Performance.getUsablePath(uri) 78 | val file = File(Environment.getExternalStorageDirectory(), formattedPath) 79 | val files = DocumentFileCompat.fromFile(context, file).listFiles() 80 | size = files.size 81 | }.also { time -> 82 | // building a DFC model with File will take a few ms against the native perf. 83 | val message = "Folder has $size items.\nDFC (File API) Performance = ${time}s" 84 | return (message) 85 | } 86 | } 87 | 88 | private fun calculateDocumentFileCompatPerformance(context: Context, uri: Uri): String { 89 | measureTimeSeconds { 90 | val documentFile = DocumentFileCompat.fromTreeUri(context, uri) 91 | documentFile?.listFiles() 92 | }.also { time -> 93 | // This files have Uri, Name, Last Modified time for easy accessibility 94 | return ("DFC Performance = ${time}s") 95 | } 96 | } 97 | 98 | private fun calculateDocumentFilePerformance(context: Context, uri: Uri): String { 99 | measureTimeSeconds { 100 | val listOfUsableElements = arrayListOf() 101 | DocumentFile.fromTreeUri(context, uri)?.listFiles()?.forEach { documentFile -> 102 | listOfUsableElements.add( 103 | Performance.FileHolderPojo( 104 | documentFile.uri, 105 | // Each of this will call ContentResolver 106 | documentFile.name.orEmpty(), 107 | documentFile.length().toInt(), 108 | documentFile.lastModified(), 109 | documentFile.type.orEmpty(), 110 | ) 111 | ) 112 | } 113 | }.also { time -> return ("DocumentFile Performance = ${time}s") } 114 | } 115 | 116 | private fun calculateDocumentFilePerformanceOnlyUri(context: Context, uri: Uri): String { 117 | measureTimeSeconds { 118 | DocumentFile.fromTreeUri(context, uri)?.listFiles() 119 | }.also { time -> 120 | // These files only have a Uri, so this operation is kinda faster 121 | return ("DocumentFile Performance (Uri Only) = ${time}s") 122 | } 123 | } 124 | 125 | private fun calculateDocumentFilePerformanceWithName(context: Context, uri: Uri): String { 126 | measureTimeSeconds { 127 | val listOfUsableElements = arrayListOf() 128 | DocumentFile.fromTreeUri(context, uri)?.listFiles()?.forEach { documentFile -> 129 | listOfUsableElements.add(documentFile.name.orEmpty()) 130 | } 131 | }.also { time -> return ("DocumentFile Performance (With Names) = ${time}s") } 132 | } 133 | 134 | private fun calculateDocumentFileCompatPerformanceWithName(context: Context, uri: Uri): String { 135 | measureTimeSeconds { 136 | val listOfUsableElements = arrayListOf() 137 | DocumentFileCompat.fromTreeUri(context, uri)?.listFiles()?.forEach { documentFile -> 138 | listOfUsableElements.add(documentFile.name) 139 | } 140 | }.also { time -> 141 | return ("DFC Performance (With Names) = ${time}s") 142 | } 143 | } 144 | } -------------------------------------------------------------------------------- /app/src/main/java/com/lazygeniouz/filecompat/example/performance/FilesPerformance.kt: -------------------------------------------------------------------------------- 1 | package com.lazygeniouz.filecompat.example.performance 2 | 3 | import android.content.Context 4 | import android.net.Uri 5 | import android.os.Environment 6 | import androidx.documentfile.provider.DocumentFile 7 | import com.lazygeniouz.dfc.file.DocumentFileCompat 8 | import com.lazygeniouz.filecompat.example.performance.Performance.getSizeInMb 9 | import com.lazygeniouz.filecompat.example.performance.Performance.measureTimeSeconds 10 | import java.io.File 11 | import java.text.SimpleDateFormat 12 | import java.util.* 13 | 14 | object FilesPerformance { 15 | 16 | fun calculateFileSidePerformance(context: Context, uri: Uri): String { 17 | var results = "" 18 | results += calculateFilePerformance(uri) + "\n\n\n" 19 | results += calculateFileCompatPerformance(context, uri) + "\n\n\n" 20 | results += calculateDocumentFilePerformance(context, uri) + "\n" 21 | return results 22 | } 23 | 24 | // Native File 25 | private fun calculateFilePerformance(uri: Uri): String { 26 | var message = "" 27 | measureTimeSeconds { 28 | val usableUri = Performance.getUsablePath(uri) 29 | val file = File(Environment.getExternalStorageDirectory(), usableUri) 30 | message = buildString(file.name, file.extension, file.lastModified(), file.length()) 31 | }.also { time -> 32 | message = "$message\nNative File Performance = ${time}s" 33 | return (message) 34 | } 35 | } 36 | 37 | // FileCompat 38 | private fun calculateFileCompatPerformance(context: Context, uri: Uri): String { 39 | var message = "" 40 | measureTimeSeconds { 41 | val file = DocumentFileCompat.fromSingleUri(context, uri) ?: return@measureTimeSeconds 42 | message = buildString( 43 | file.name, file.extension, 44 | file.lastModified, file.length 45 | ) 46 | }.also { time -> 47 | message = "$message\nDFC Performance = ${time}s" 48 | return (message) 49 | } 50 | } 51 | 52 | // DocumentFile 53 | private fun calculateDocumentFilePerformance(context: Context, uri: Uri): String { 54 | var message = "" 55 | measureTimeSeconds { 56 | val documentFile = DocumentFile.fromSingleUri(context, uri) 57 | message = buildString( 58 | documentFile?.name!!, 59 | documentFile.name!!.substringAfterLast("."), 60 | documentFile.lastModified(), 61 | documentFile.length() 62 | ) 63 | }.also { time -> 64 | message = "$message\nDocumentFile Performance = ${time}s" 65 | return (message) 66 | } 67 | } 68 | 69 | private fun buildString( 70 | name: String, extension: String, 71 | lastModified: Long, fileSize: Long, 72 | ): String { 73 | return "Name: ${name}," + 74 | "\nSize: ${getSizeInMb(fileSize)}, " + 75 | "Extension: ${extension}, " + 76 | "\nLast modified: ${ 77 | SimpleDateFormat("dd-MM-yyyy", Locale.getDefault()) 78 | .format(Date(lastModified)) 79 | }" 80 | } 81 | } -------------------------------------------------------------------------------- /app/src/main/java/com/lazygeniouz/filecompat/example/performance/Performance.kt: -------------------------------------------------------------------------------- 1 | package com.lazygeniouz.filecompat.example.performance 2 | 3 | import android.content.Context 4 | import android.net.Uri 5 | import kotlin.system.measureTimeMillis 6 | 7 | object Performance { 8 | 9 | private val Long.toSeconds get() = (this / 1000.00) 10 | 11 | fun calculateDirectoryPerformance(context: Context, uri: Uri): String { 12 | return DirectoryPerformance.calculateDirectorySidePerformance(context, uri) 13 | } 14 | 15 | fun calculateFilesPerformance(context: Context, uri: Uri): String { 16 | return FilesPerformance.calculateFileSidePerformance(context, uri) 17 | } 18 | 19 | fun getUsablePath(uri: Uri): String { 20 | val path = uri.path!! 21 | return when { 22 | path.contains(":") -> path.split(":")[1] 23 | path.contains("tree") -> path.substringAfter("tree/") 24 | else -> path 25 | } 26 | } 27 | 28 | fun measureTimeSeconds(block: () -> Unit): Double { 29 | return measureTimeMillis(block).toSeconds 30 | } 31 | 32 | fun getSizeInMb(size: Long): String { 33 | return String.format("%.2f Mb", (size / 1024) / 1024.00f) 34 | } 35 | 36 | data class FileHolderPojo( 37 | val documentUri: Uri, 38 | val documentName: String = "", 39 | val documentSize: Int = 0, 40 | val lastModifiedTime: Long = -1L, 41 | val documentMimeType: String = "", 42 | ) 43 | } -------------------------------------------------------------------------------- /app/src/main/res/drawable-v24/ic_launcher_foreground.xml: -------------------------------------------------------------------------------- 1 | 7 | 8 | 9 | 15 | 18 | 21 | 22 | 23 | 24 | 30 | -------------------------------------------------------------------------------- /app/src/main/res/drawable/ic_launcher_background.xml: -------------------------------------------------------------------------------- 1 | 2 | 7 | 10 | 15 | 20 | 25 | 30 | 35 | 40 | 45 | 50 | 55 | 60 | 65 | 70 | 75 | 80 | 85 | 90 | 95 | 100 | 105 | 110 | 115 | 120 | 125 | 130 | 135 | 140 | 145 | 150 | 155 | 160 | 165 | 170 | 171 | -------------------------------------------------------------------------------- /app/src/main/res/layout/activity_main.xml: -------------------------------------------------------------------------------- 1 | 2 | 7 | 8 | 13 | 14 | 20 | 21 |