احتمالا با مشاهده تصویر بالا متوجه شده‌اید که در این مبحث می‌خواهیم راجع به چه موضوعی صحبت کنیم. بسته به میزان حجم یک پروژه اندرویدی، فرایند بیلد شدن آن بین چند ثانیه تا چندین دقیقه می‌تواند زمان بر باشد. بنابراین اجرای روش‌های افزایش سرعت بیلد Gradle در اندروید استودیو می‌تواند تا چندین برابر، مدت زمان این فرایند طولانی و خسته کننده را کاهش دهد.
بهینه سازی صحیح اندروید استودیو و بیلد سیستم آن یعنی گریدل، می‌تواند یک فرآیند چند دقیقه‌ای بیلد را به چند ثانیه کاهش دهد! پس توصیه می‌کنم این قسمت از سری مباحث آموزش برنامه نویسی اندروید را با دقت و تا انتها مطالعه کنید.

دلایل کاهش سرعت بیلد شدن پروژه اندرویدی

به نام خدا. عموما وقتی صحبت از کندی سرعت اجرای یک نرم افزار به میان می‌آید در اولین قدم انگشت اتهام به سمت سخت افزار رایانه رفته و پایین بودن کانفیگ سخت افزاری سیستم به عنوان علت اصلی بروز مشکل بیان می‌شود.
قطعا سخت افزار نقش تعیین کننده‌ای در سرعت اجرای ابزار و نرم افزارها به عهده دارد اما این همه‌ی ماجرا نیست. بهینه سازی ابزار مورد استفاده نیز می‌تواند تا حد زیادی و در مواقعی تا چند برابر سرعت انجام عملیات را افزایش دهد بدون آنکه نیازی به ارتقاء سخت افزار و صرف هزینه‌های گزاف وجود داشته باشد.

حتی یک PC یا Laptop قدرتمند و با کانفیگ بالا هم از این قاعده مستثنی نبوده و در صورت عدم بهینه سازی ابزار مورد استفاده، هنگام رندر شدن یک پروژه گرافیکی سنگین یا بیلد شدن پروژه اندرویدی در اندروید استودیو با کاهش بازدهی و افزایش زمان مواجه خواهیم شد.
بنابراین به عنوان یک برنامه نویس و توسعه دهنده اندروید اگر یک سیستم با مشخصات سخت افزاری بالا در اختیار داریم نباید این حس به ما القاء شود که نیازی به بهینه سازی نیست!
در این جلسه سعی می‌کنم مهمترین مواردی که در افزایش سرعت بیلد Gradle در اندروید استودیو موثر هستند را معرفی کنم.

روش‌های افزایش سرعت بیلد Gradle در اندروید استودیو

هر کدام از مواردی که در ادامه ذکر می‌شود درصد متفاوتی در کاهش نهایی زمان بیلد شدن پروژه اندرویدی سهم خواهد داشت بنابراین اکتفا کردن به یک یا چند مورد، تاثیر حداکثری را به همراه نخواهد داشت.
بنابراین درخواست می‌کنم تمامی آیتم‌ها را به دقت و با حوصله کافی مطالعه و اجرا کنید تا بتوانید حداکثر بهره وری را از سیستم خود کسب کرده و در نهایت، کمترین زمان را برای بیلد شدن پروژه‌های اندرویدی خود هدر دهید.

استفاده از جدیدترین نسخه پلاگین Gradle

به مرور زمان نسخه‌های جدیدتری از پلاگین گریدل منتشر می‌شود که تعدادی از مشکلات و باگ‌ها رفع شده و نسبت به نسخه‌های قبل بهینه تر هستند که در نتیجه مقداری از زمان انتظار ما برای بیلد شدن پروژه‌های اندرویدی کاسته می‌شود.
البته عمدتا این افزایش بازدهی به قدری ملموس نیست که بخواهد به یکباره زمان بیلد را ۵۰ درصد کاهش دهد اما بهرحال بی تاثیر هم نیست. ضمن اینکه با گذشت زمان و رشد قابلیت‌ها و امکانات ابزارهای هوشمند و بویژه سیستم عامل اندروید، حجم کتابخانه‌ها، پلاگین‌ها و کدهای پروژه اندرویدی نیز افزایش یافته و به نوعی این افزایش سرعت بیلد گریدل و حجم کدها باعث همپوشانی یکدیگر می‌شود.

بر اساس چارت فوق که در مستندات وب سایت Gradle منتشر شده، در کامپایل یک پروژه جاوایی که حاوی ۱۰۰۰ ماژول بوده، مدت زمان بیلد از حدود ۴ ثانیه در گریدل ۲٫۱۴ به ۲٫۵ ثانیه در گریدل ۵ کاهش یافته است. یعنی چیزی حدود ۳۰ درصد.
برای بروزرسانی Gradle نیاز به انجام کار اضافی نیست. با نصب نسخه جدید اندروید استودیو و یا بروزرسانی آن چنانچه نسخه جدیدی از گریدل و البته سازگار با آن نسخه از اندروید استودیو منتشر شده باشد به صورت خودکار دریافت و جایگزین نسخه قدیمی خواهد شد.
اما چنانچه قصد دارید بدون بروزرسانی اندروید استودیو از آخرین نسخه گریدل استفاده کنید لازم است نسخه پلاگین در build.gradle (Project) در بلاک dependencies بروز شود:

dependencies {
    classpath "com.android.tools.build:gradle:4.1.1"
}

در زمان تهیه این آموزش Gradle plugin 4.1.1 روی اندروید استودیو من فعال است که البته به من پیشنهاد می‌دهد نسخه ۴٫۱٫۲ را نصب کنم:

پلاگین را به ۴٫۱٫۲ ارتقاء داده و پروژه را Sync می‌کنم. بلافاصله اندروید استودیو شروع به دانلود گریدل ۶٫۵ می‌کند:

یعنی برای استفاده از نسخه جدید پلاگین گریدل، خود گریدل نیز باید ابتدا بروز شود. لینک فایل گریدل در gradle-wrapper.properties ذخیره می‌شود که در صورت نیاز می‌توان به صورت دستی هم آنرا تغییر داد:

gradle-wrapper.properties

distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-6.5-all.zip

برای کسب اطلاع دقیق از جزئیات مربوط به نسخه‌های گریدل و پلاگین‌های سازگار با آن به صفحه Android Gradle plugin مراجعه کنید.

استفاده از آخرین نسخه Java

در زمان تهیه این آموزش Java 8 آخرین نسخه از جاوا است. جاوا ۸ (با عنوان ۱٫۸) نسبت به نسخه‌های قبلی خود سرعت بیشتری دارد و اگر هنوز از جاوا ۱٫۶ یا ۱٫۷ استفاده می‌کنید حتما آن را به ۱٫۸ یا جدیدترین نسخه موجود ارتقا دهید.
البته اگر به یاد داشته باشید در نسخه‌های ابتدایی محیط توسعه اندروید استودیو لازم بود JDK را به صورت دستی روی سیستم نصب کرده و سپس محل نصب را به آن معرفی کنیم. اما در نسخه‌های اخیر، تیم توسعه دهنده اندروید استودیو این زحمت را هم از روی دوش برنامه نویس‌های اندرویدی برداشته و یک نسخه از OpenJDK را درون IDE تعبیه کرده‌اند.
بنابراین با بروزرسانی اندروید استودیو مطمئن هستیم که آخرین نسخه از JDK را استفاده می‌کنیم. با اینحال برای اطمینان از نصب آخرین نسخه جاوا کافیست بلاک compileOptions در build.gradle (Module:app) را بررسی کنیم:

compileOptions {
    sourceCompatibility JavaVersion.VERSION_1_8
    targetCompatibility JavaVersion.VERSION_1_8
}

در کد فوق نسخه ۸ جاوا قید شده. همچنین در محل نصب JDK توسط Command line می‌توان با دستور java -version نسخه جاوای موجود را بررسی کرد.
اگر اندروید استودیو را در مسیر پیش فرض نصب کرده‌اید محلی که می‌توان نسخه جاوا را چک کرد به صورت زیر است:

C:\Program Files\Android\Android Studio\jre\bin

در سیستم عامل ویندوز در این پنجره روی صفحه shift و راست کلیک کرده و گزینه Open PowerShell window here یا Open Command line window here را انتخاب می‌کنم تا پنجره خط فرمان باز شود:

ملاحظه می‌کنید با نوشتن دستور java -version نسخه ۱٫۸ نمایش داده شد.

فعال کردن حالت آفلاین Gradle

یکی دیگر از گزینه‌های افزایش سرعت بیلد Gradle در اندروید استودیو آفلاین کردن گریدل است. چنانچه گریدل در حالت پیش فرض خود یعنی Online قرار داشته باشد ممکن است در حین فرایند بیلد پروژه دانلود تعدادی فایل را آغاز کند که همین امر موجب افزایش زمان بیلد می‌شود. بهتر است فقط زمانی گریدل را در حالت آنلاین قرار دهیم که می‌خواهیم یک کتابخانه جدید به پروژه اضافه کنیم که قبلا استفاده نشده و در کش گریدل موجود نیست.
کتابخانه‌هایی که قبلا یکبار در همین پروژه یا پروژه‌ای دیگر استفاده شده و به صورت آنلاین دریافت شده‌اند تا زمانی که به صورت دستی حذف نشود در کش موجود بوده و بدون نیاز به اتصال مجدد قابل استفاده خواهد بود (مگر آنکه بخواهیم نسخه جدیدتر آن کتابخانه را نصب کنیم).
برای اینکار کافیست در نوار سمت راست اندروید استودیو و یا منوی View > Tool windows گزینه Gradle و سپس Toggle Offline Mode را انتخاب کنید:

مهاجرت به لینوکس!

قبلا هم می‌دانستم اندروید استودیو در اجرا و همچنین بیلد شدن پروژه‌ها در توزیع‌های لینوکسی محبوب مانند Ubuntu سرعت بیشتری نسبت به ویندوز دارد. اما برای اطمینان بیشتر عبارت “Does Android Studio run faster on Linux?” را گوگل کردم تا تجربه سایر افراد را در این زمینه بدانم. تقریبا همه آنها از افزایش سرعت حتی تا %۵۰ بعد از مهاجرت به Ubuntu را اعلام کرده بودند. برای نمونه می‌توانید این بحث موجود در Quara را بررسی کنید.
البته برای کسی مثل من شاید مهاجرت از ویندوز به لینوکس سخت باشد اما بهرحال یکی از گزینه‌ها بود و لازم میدانستم به آن اشاره کنم.

عدم استفاده از ورژن‌های داینامیک کتابخانه‌ها

اگر عادت کرده‌اید هنگام افزودن یک کتابخانه به پروژه اندرویدی خود برای سادگی کار بجای درج نسخه دقیق آن، یک “+” قرار دهید از امروز اشتباه خود را اصلاح کنید! داینامیک بودن نسخه کتابخانه‌ها باعث می‌شود تا گریدل هر ۲۴ ساعت یکبار به مخزن آنلاین متصل شده تا بررسی کند آیا نسخه جدیدتری منتشر شده یا نه.
برای مثال در زمان نگارش این آموزش، ورژن ۲٫۹٫۰ آخرین نسخه از کتابخانه Retrofit است.

dependencies {
    implementation 'com.squareup.retrofit2:retrofit:+'
}

dependencies {
    implementation 'com.squareup.retrofit2:retrofit:2.9.0'
}

در کدهای فوق، مورد اول اشتباه و مورد دوم صحیح است. بگذریم از اینکه در مواردی حتی کتابخانه‌های پیش فرض پروژه هم به همین صورت تعریف شده است:

‌استفاده حداقلی از کتابخانه‌ها

بالا رفتن تعداد کتابخانه‌های اضافه شده به پروژه می‌تواند سرعت بیلد را به همان نسبت کاهش دهد. اگر کتابخانه‌ای را قبلا اضافه کرده‌اید و الان به هر دلیل از استفاده از آن منصرف شده‌اید حتما نسبت به حذف آن از پروژه اقدام کنید.
همچنین برخی کتابخانه‌ها ترکیبی از دو یا چند کتابخانه دیگر هستند. اگر فقط به یکی از زیر مجموعه‌های آن نیاز دارید فقط همان را اضافه کنید تا از اضافه شدن کتابخانه‌های بلا استفاده جلوگیری گردد.
ضمن اینکه توجه داشته باشید یک کتابخانه فقط یکبار به پروژه اضافه شده باشد. برای مثال کتابخانه Retrofit Gson Converter خودش از کتابخانه Gson گوگل استفاده می‌کند بنابراین نیازی نیست در کنار آن، دوباره کتابخانه Gson را تعریف کنیم.
با استفاده از دستور

gradlew app:dependencies

در Terminal می‌توانید لیست کامل کتابخانه‌های بکار رفته در پروژه را مشاهده کنید:

نحوه کار با ترمینال در ادامه همین آموزش (ساخت پروفایل برای بیلد و بررسی آن) توضیح داده شده است.

اعمال تغییرات بجای اجرای دوباره هنگام تست و دیباگ

اگر پروژه روی شبیه ساز اندرویدی یا یک دیوایس حقیقی در حال اجرا (Run) است و می‌خواهیم تغییری در کدها اعمال کنیم، بهتر است بجای Run کردن دوباره‌ی پروژه از گزینه Apply Changes استفاده کنیم. با اجرای مجدد پروژه، اپلیکیشن به طور کامل ریستارت شده و به عبارتی یک APK جدید ساخته می‌شود که جایگزین APK ای که در اجرای قبلی روی دیوایس نصب شده خواهد شد. این یعنی اتلاف زمان و منابع.
در صورتی که گزینه Apply Changes صرفا بخشی از برنامه که کدهای آن ویرایش شده را به دیوایسی که پروژه روی آن در حال اجراست ارسال می‌کند و یک APK جدید جایگزین نخواهد شد.

قابلیت Apply Changes در اندروید استودیو ۳٫۵ معرفی و جایگزین Instant Run شد که در نسخه ۲ اضافه شده بود. بر اساس مستندات توسعه دهندگان اندروید استودیو، برخلاف Instant Run که تغییرات انجام شده در پروژه را از طریق بازنویسی بایت کد APK روی دیوایس اعمال می‌کرد، در Apply Changes کلاس‌های موردنظر دوباره تعریف می‌شوند که فرایند بهینه‌تر و کوتاهتری حاصل می‌شود.
البته استفاده از این قابلیت صرفا بر روی دیوایس‌های با Android 8 (API 26) و به بالا قابل انجام است. ضمن اینکه اعمال برخی تغییرات در پروژه‌در در حال اجرا صرفا با ریستارت شدن یا به عبارتی Run کردن دوباره پروژه انجام خواهد شد و Apply Changes کاربردی نخواهد داشت مانند حذف یا اضافه کردن یک متد، فیلد یا کلاس.
توضیحات تکمیلی را در صفحه Build and Run مستندات اندروید مطالعه کنید.

انجام تغییرات در Gradle

با فعال کردن تعدادی از قابلیت‌های گریدل می‌توان باز هم افزایش سرعت بیلد Gradle در اندروید استودیو را شاهد باشیم. این کدها در فایل gradle.properties اضافه می‌شود:

Gradle Daemon: این قابلیت یک فرایند پس زمینه‌ای است و فعال کردن آن باعث می‌شود برای عملیات بیلد پروژه، گریدل حافظه بیشتری در اختیار داشته باشد که به کاهش زمان انجام عملیات منجر خواهد شد.

org.gradle.deamon=true
 

اگر مایلید در این زمینه اطلاعات کاملتری کسب کنید صفحه Gradle Daemon را مطالعه کنید.

Parallel Build Execution: به طور پیش فرض گریدل تنها یک کار را در آن واحد انجام می‌دهد اما با اضافه کردن خط زیر، گریدل چندین عملیات را همزمان و به طور موازی اجرا خواهد کرد.

org.gradle.parallel=true

البته این قابلیت تنها هنگامی موثر است که پروژه ماژولار ساخته شده باشد. آشنایی بیشتر با این قابلیت در این صفحه.

Configure On Demand: احتمال اینکه این قابلیت مورد استفاده ما قرار گیرد بسیار کم است زیرا صرفا در پروژه‌ای که اصطلاحا Multi-project نامیده می‌شود کاربرد خواهد داشت. پروژه‌ای که خودش دارای چند زیرشاخه مانند mobile و tv باشد.
به بیان ساده تر، هنگامی که بخواهیم این Multi-project را روی یک دستگاه موبایل اجرا کنیم، فقط همین قسمت بیلد شده و قسمت مربوط به tv بیلد نخواهد شد.

org.gradle.configureondemand=true

اطلاعات بیشتر در این زمینه: اینجا

تخصیص حافظه بیشتر به کامپایلر جاوا: می‌توانیم مقدار حافظه در دسترس برای کامپایلر را افزایش دهیم تا فرایند کامپایل با سرعت بالاتری انجام شود. برای مثال در خط زیر مقدار ۲ گیگابایت (۲۰۴۸ مگابایت) تعیین شده است.

org.gradle.jvmargs=-Xmx2048m -XX:MaxPermSize=512m -XX:+HeapDumpOnOutOfMemoryError -Dfile.encoding=UTF-8

بر اساس مقدار حافظه سیستم می‌توان عدد بزرگتری نیز در نظر گرفت.

فعال کردن Gradle build cache: با فعال شدن قابلیت کش، گریدل از خروجی بیلدهای قبلی پروژه استفاده می‌کند که می‌تواند تا حدود ۳ برابر برای یک بیلد کامل (Full build) و ۱۰ برابر برای یک اعمال تغییر کوچک در پروژه (Incremental build) افزایش سرعت و کاهش زمان بیلد را به همراه داشته باشد.

org.gradle.caching=true

غیر فعال کردن PNG Crunching

هنگام بیلد شدن پروژه برای کاهش حجم فایل اپلیکیشن چنانچه تصاویری با فرمت PNG در منابع وجود داشته باشد فشرده خواهند شد که این فرایند به مدت زمان بیلد می‌افزاید. مسلما این قابلیت برای نسخه release نهایی که قصد انتشار آن را داریم یک مزیت محسوب می‌شود اما در هنگام تست و عیب یابی پروژه طبیعتا کاهش حجم اپ اهمیتی برای ما نخواهد داشت. لذا با غیر فعال کردن آن تا حدودی از زمان بیلد کاسته خواهد شد.
البته از اندروید استودیو ۳ به بعد این قابلیت به طور پیش فرض برای خروجی debug غیر فعال بوده و صرفا برای نسخه release انجام این کار لازم است. در بلاک release داخل بلاک BuildTypes فایل build.gradle(app) برای ویژگی crunchPngs مقدار false تعریف می‌کنم. اگر به یاد داشته باشید تنظیمات مربوط به فعال کردن پروگارد (R8) نیز در همین بلاک قرار داشت.

buildTypes {

    release {

        crunchPngs false

    }
}

البته شاید بهتر باشد بجای استفاده از تصاویر PNG از همان ابتدا از فرمت جدید تصاویر با نام WebP استفاده کنیم تا اولا نیازی به غیر فعال کردن موقت crunchPngs و فعال کردن مجدد آن هنگام release نهایی نداشته باشیم و دوما در همه حالت‌ها چه debug و چه release تست و نهایی، حجم برنامه ما در کمترین حالت ممکن از نظر resource ها قرار بگیرد.
WebP فرمتی است که عمدتا در وب در حال فراگیر شدن بوده و جایگزینی آن با فرمت PNG به مرور در حال افزایش است. اگر با واژه سئو (SEO) آشنا هستید، یکی از آیتم‌های مهم در بهبود وضعیت سئو یک وب سایت، کاهش حجم صفحات و بخصوص تصاویر درون آن به شمار می‌رود.
با اینحال چنانچه به هر دلیلی استفاده از WebP برایتان مقدور نیست، غیر فعال کردن crunchPngs به عنوان راهکار جایگزین در دسترس قرار دارد.

جلوگیری از Legacy Multidex

قبل از پرداختن به این مورد خلاصه بگویم؛ اگر برای تست و دیباگ پروژه اندرویدی خود صرفا از دیوایس‌های مجازی یا حقیقی با API 21 (Android 5.0) و به بالا استفاده می‌کنید مشکلی وجود ندارد و بدون مطالعه این قسمت از آن عبور کنید.
قبلا در مبحث آشنایی با سیستم عامل اندروید گفتیم که از نسخه ۵٫۰ اندروید، ران تایم ART جایگزین Dalvik شد. محدودیتی که در Dalvik وجود دارد این است که در یک فایل DEX (که بعد از کامپایل پروژه درون APK ساخته می‌شود) حداکثر ۶۴k یا به عبارتی ۶۵۵۳۶ متد می‌تواند ارجاع داده شود.
لذا چنانچه در حال توسعه یک پروژه با مقیاس بزرگ هستیم و مجموع تعداد متدهای تعریف شده در پروژه (شامل کدها، کتابخانه‌ها و…) بیشتر از این عدد باشد و minSdkVersion هم روی API 20 و یا پایینتر تنظیم شده باشد، لازم است کتابخانه Multidex روی پروژه نصب و فعال شود تا متدها در دو یا چند فایل DEX قرار گیرد.
این آموزش جایی برای پرداختن به نحوه فعالسازی این کتابخانه نیست و چنانچه یکی از ارورهای

trouble writing output:
Too many field references: 131000; max is 65536.
You may try using --multi-dex option.

و یا

Conversion to Dalvik format failed:
Unable to execute dex: method ID not in [0, 0xffff]: 65536

گرفته‌اید صفحه فعالسازی Multidex را در مستندات اندروید مطالعه کنید.
بهتر است قبل از فعالسازی Multidex یکبار پروژه را بازنگری کنید. اگر کد یا کتابخانه اضافی هست که امکان حذف آن وجود دارد و با اینکار، تعداد متدها از محدودیت اعلام شده کمتر خواهد شد، نسبت به استفاده از Multidex در اولویت خواهد بود.
فعال بودن این قابلیت نه تنها باعث افزایش سرعت بیلد Gradle در اندروید استودیو نمی‌شود بلکه با کاهش سرعت و افزایش زمان بیلد مواجه خواهیم شد. لذا یا باید minSdkVersion را روی API 21 و به بالا تنظیم کرد و یا اینکه پروژه را روی دیوایس‌های Android 5.0 به بالا اجرا و تست کنیم تا Multidex دخالتی در فرایند بیلد شدن پروژه نداشته باشد. ضمن اینکه نباید از اندروید استودیو نسخه ۲٫۳ و پایینتر از آن استفاده کرد.

جلوگیری از کامپایل منابع غیر ضروری

اگر برنامه‌ای که در حال توسعه آن هستید شامل چند زبان مانند فارسی و انگلیسی بوده و یا برای چندین اندازه صفحه طراحی شده، هنگام بیلد شدن پروژه تمامی این resource ها کامپایل می‌شود. در صورتی که هنگام تست و دیباگ ما فقط به یک زبان و یک اندازه تراکم صفحه نیاز داریم.
بنابراین با محدود کردن این موارد در هنگام تست و دیباگ پروژه می‌توانیم از اتلاف زمان برای کامپایل شدن منابع اضافی و غیر ضرور اجتناب کنیم.
یک بلاک با نام productFlavors در بلاک android در build.gradle(app) اضافه می‌کنم. تنظیماتی که مدنظر دارم فقط باید در هنگام تست پروژه اجرا شود و نه در زمان گرفتن خروجی APK یا AAB برای انتشار. بنابراین یک بلاک جدید با نام dev در productFlavors تعریف کرده و تنظیمات موردنظرم را داخل آن اضافه می‌کنم:

android {

    ...

    productFlavors {

        dev {

            resConfigs "fa", "xhdpi"

        }

    }

}

در مثال فوق هنگام Run شدن پروژه و یا گرفتن نسخه debug فقط زبان فارسی و اندازه صفحه (تراکم صفحه) xhdpi کامپایل شده و مابقی موارد چشم پوشی خواهد شد.

عدم استفاده از مقادیر داینامیک

اگر در مواردی مانند تعیین versionCode در پروژه اندرویدی خود از مقادیر داینامیک بجای استاتیک استفاده می‌کنید، در عین حال اینکه از انجام یک کار روتین راحت می‌شوید اما باید بدانید که به مدت زمان بیلد پروژه افزوده خواهد شد.

def buildTime = new Date().format('yyMMddHHmm').toInteger()

android {
    
    defaultConfig {
        
        versionCode buildTime

    }

}

در کد فوق از کلاس Date جاوا برای تعیین versionCode استفاده شده. بهتر است از انجام این کار اجتناب کرده و کد را به صورت دستی تغییر دهید.

غیر فعال کردن Crashlytics

اگر برای دریافت گزارشات کرش برنامه خود از ابزار Crashlytics استفاده می‌کنید اما نیازی نمی‌بینید هنگام دیباگ فعال باشد بهتر است این پلاگین در نسخه‌های debug غیر فعال شود تا از تاثیر منفی آن در مدت زمان بیلد شدن پروژه جلوگیری گردد.
برای اینکار خط زیر را در بلاک debug می‌کنم:

android {
    ...

    buildTypes {

        debug {

            ext.enableCrashlytics = false

        }

    }

}

اما اگر نیاز داریم این پلاگین در هنگام دیباگ هم فعال باشد باز هم با جلوگیری از بروز شدن Build id پلاگین Crashlytics در هر بیلد، می‌توان تا حدودی از زمان بیلد را کاهش داد:

android {
    ...

    buildTypes {

        debug {

            ext. alwaysUpdateBuildId = false

        }

    }

}

غیر فعال کردن Multi APK

اگر از قابلیت Multi APK برای ساخت چندین نسخه از اپلیکیشن برای دیوایس‌های با مشخصات سخت افزاری متفاوت استفاده می‌کنید، قطعا در هنگام تست و دیباگ نیازی به این قابلیت نیست و بهتر است غیر فعال شود.
کافیست در بلاک debug دو خط زیر تعریف شود تا برای همه سایزهای صفحه نمایش (density) و همچنین معماری‌های CPU (abi) فقط یک APK ساخته شود:

buildTypes {
    ...
    debug {
        splits.abi.enable = false
        splits.density.enable = false
    } 
}

جلوگیری از کامپایل مداوم کتابخانه‌ها

طبیعتا در حین توسعه یک اپلیکیشن بارها و بارها نیاز به اصلاح و تغییر کدها و تست مجدد آن روی دیوایس اندرویدی داریم. اما کتابخانه‌هایی که در پروژه استفاده شده بدون تغییر هستند و واقعا نیازی نیست با هر بار بیلد شدن پروژه، کتابخانه‌های داخل پروژه نیز دوباره بیلد شده و درون فایل DEX در کنار دیگر کدهای کامپایل شده قرار گیرد.
با افزودن بلاک dexOptions به بلاک android در build.gradle(app) و تعیین مقدار true برای ویژگی preDexLibraries از این پس کتابخانه‌ها فقط یکبار کامپایل شده و در دفعات بعد فقط کدهای پروژه مجدد کامپایل خواهند شد.

android {

  ...    

    dexOptions { 

        preDexLibraries true

    }

}

البته دقت داشته باشید این قابلیت فقط در تغییرات جزئی (Apply Changes) موجب افزایش سرعت بیلد Gradle در اندروید استودیو خواهد شد ولی در بیلدهای کامل می‌تواند باعث کاهش سرعت بیلد گریدل شود. بنابراین بهتر است هنگام بیلدهای کامل، این قابلیت غیر فعال (false) باشد.

ساخت پروفایل برای بیلد و بررسی آن

یکی از امکانات دیگری که Gradle در اختیار توسعه دهندگان قرار داده، ساخت Profile برای هر بیلد است. با فعال کردن پروفایل، بعد از هر خروجی APK ای که از پروژه می‌گیریم، یک گزارش جامع و کامل پیرامون مراحل بیلد و اینکه هر کدام چه مدت زمانی از فرایند کامل بیلد را به خود اختصاص داده در قالب یک فایل HTML در مسیر Project Directory > build > reports > profile ذخیره می‌شود.
برای فعال کردن profile دو راه وجود دارد:
۱٫ تعریف دستور – -profile در تنظیمات کامپایلر اندروید استودیو: کافیست یکبار دستور --profile را در قسمت Command-line Options در مسیر Settings > Build, Execution, Deployment > Compiler تعریف کنیم:

حالا با هربار اجرای پروژه روی شبیه ساز یا دیوایس واقعی و یا گرفتن APK نسخه debug یا release یک پروفایل با پسوند html در پوشه profile ذخیره خواهد شد:

با باز کردن هر فایل در مرورگر، تمامی جزئیات بیلد در ۵ دسته بندی متفاوت نمایش داده می‌شود:

در هر قسمت، عدد زیر Duration زمانِ مربوط به یک بخش از فرایند بیلد را نشان می‌دهد. با بررسی همه قسمت‌ها شامل Summary، Configuration، Dependency Resolution، Artifact Transforms و Task Execution می‌توانیم تشخیص دهیم چه مواردی بیشترین زمان بیلد را به خود اختصاص می‌دهد و کدامیک را می‌توان بهینه و یا کاملا حذف کرد.
۲٫ اضافه کردن – -profile به دستورات در خط فرمان: اگر عادت به استفاده از دستورات دارید، برای اضافه کردن پروفایل به بیلد باید --profile به انتهای دستور اضافه شود:

gradlew assembleDebug --profile

ملاحظه می‌کنید پس از اجرای فرمان در Terminal اندروید استودیو، بیلد پروژه انجام شده و در انتهای آن لینک فایل html پروفایل هم نمایش داده شده است.

./gradlew assembleDebug --profile

طراحی ماژولار پروژه

Modular که در فارسی ماژولار نامیده می‌شود بیانگر سبکی از طراحی و ساخت است که یک پروژه بزرگ از ترکیب چندین واحد کوچکتر تشکیل می‌شود که هر واحد را یک ماژول می‌نامیم.
تقسیم بندی برنامه به چند واحد (ماژول) علاوه بر مزایایی مانند توسعه و عیب یابی و بروزرسانی ساده تر و سریع تر و پیچیدگی کمتر، باعث می‌شود تا در فرایند تست و عیب یابی اپ، بیلد سیستم Gradle تنها ماژولی را کامپایل کند که ویرایش و اصلاح شده و مابقی ماژول‌هایی که ویرایش نشده‌اند برای بیلدهای بعدی کش شود که می‌توان کاهش زمان بیلد گریدل را به مقدار زیادی در بیلدهای آتی شاهد بود.
با توجه به مفصل بودن طراحی ماژولار، به همین توضیحات مختصر اکتفا می‌کنم. اگر مایل هستید در مورد آن بیشتر مطالعه کنید از گوگل کمک بگیرید یا مقاله Modularizing Android Applications را مطالعه کنید.
در این آموزش ۲۱ عامل و روش افزایش سرعت و کاهش زمان بیلد Gradle در اندروید استودیو را بررسی کردیم. امیدوارم مورد مهم دیگری از قلم نیفتاده باشد. چنانچه یک یا چند روش دیگر را تجربه و یا در جایی دیگر مطالعه کرده‌اید، در قسمت دیدگاه‌های همین مبحث در وب سایت اطلاع دهید تا در بروزرسانی بعدی اضافه شود.
موفق و پیروز باشید.

مطالعه‌ی بیشتر:

https://androidstudio.googleblog.com/2017/06/android-studio-30-canary-5-is-now.html
https://developer.android.com/studio/build/optimize-your-build

نوشته ۲۱ روش افزایش سرعت بیلد Gradle در اندروید استودیو اولین بار در اندروید استودیو پدیدار شد.

حتما می‌دانید در سیستم عامل اندروید، اپلیکیشن‌ها به صورت پیش فرض روی حافظه داخلی دستگاه نصب می‌شوند. ممکن است برخی از کاربران بخصوص آنهایی که دستگاه با سخت افزار ضعیف و حافظه داخلی پایین در اختیار دارند، تمایل داشته باشند برخی از برنامه‌ها را روی کارت حافظه یا همان حافظه خارجی دستگاه خود نصب کنند. بنابراین فعال کردن امکان نصب برنامه اندرویدی روی کارت حافظه ممکن است عاملی باشد برای جذب بیشتر مخاطب برای اپلیکیشن ما.
در این آموزش به نحوه فعال کردن قابلیت نصب اپلیکیشن بر روی حافظه خارجی دستگاه‌های اندرویدی می‌پردازیم.

در چه مواردی نصب برنامه روی کارت حافظه ضرورت دارد؟

به نام خدا. در حال حاضر شاید به سختی بتوان یک موبایل یا تبلت اندرویدی را در بازار پیدا کرد که حافظه داخلی یا به عبارتی RAM آن کمتر از ۱۶ گیگابایت باشد. هنوز یادم نرفته که اولین گوشی اندرویدی من فقط ۴ گیگابایت حافظه داخلی داشت و دائما با مشکل کمبود حافظه برای نصب برنامه‌ها مواجه بودم.
هرچند با بالا رفتن ظرفیت حافظه داخلی دیوایس‌ها نیاز کمتری به فعال کردن امکان نصب برنامه اندرویدی روی کارت حافظه احساس می‌شود با این حال هنوز هم دیوایس‌های قدیمی با حافظه کمتر از ۸ گیگابایت در دست افراد دیده می‌شود و فعال بودن این قابلیت روی برنامه ما می‌تواند نقش بیشتری در مدیریت حافظه دستگاه این دسته از افراد داشته باشد.
بخصوص در برنامه‌های سنگین و مهمتر از همه در بازی‌ها که معمولا حجم بالاتری را اشغال می‌کنند، این قابلیت بیش از پیش می‌تواند برای ما به عنوان توسعه دهنده و برنامه نویس اندرویدی در دستور کار قرار گیرد.
در ادامه مبحث به نحوه فعالسازی و همچنین جزئیات این قابلیت می‌پردازیم.

تعیین محل نصب اپلیکیشن در سیستم عامل اندروید

توسعه دهندگان سیستم عامل اندروید با انتشار اندروید ۲٫۲ (API 8) قابلیت جدیدی را در اختیار برنامه نویسان قرار دادند که به سادگی می‌توان تنظیمات مربوط به محل نصب برنامه را درون مانیفست تعیین کرد. با توجه به اینکه زمان زیادی از معرفی اندروید ۲٫۲ گذشته و بعید است دستگاهی با اندروید پایینتر از ۴ فعال باشد، از بابت سازگاری این قابلیت با دستگاه‌های موجود در اختیار کاربران جای نگرانی نیست.
برای اینکار کافیست ویژگی android:installLocation را به همراه یک مقدار، درون تگ فایل AndroidManifest.xml پروژه اضافه کنیم:

AndroidManifest.xml

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
    package="ir.android_studio.sdcard"
    android:installLocation="auto">

    . . .

</manifest>

همانطور که در تصویر مشاهده می‌کنید برای این ویژگی سه مقدار مشخص شده که بسته به نیازی که داریم می‌توان یک مورد را انتخاب کرد. کاربرد هریک از این ۳ آیتم به شرح زیر است:
Auto: چنانچه برای ویژگی installLocation مقدار auto را انتخاب کنیم، برنامه اندرویدی ما ممکن است روی حافظه خارجی (کارت SD) نصب شود اما تضمینی وجود نداشته و سیستم عامل برای انتخاب محل مناسب برای نصب برنامه، ملاک‌های متعددی را بررسی می‌کند. یکی از این آیتم‌ها، میزان فضای باقیمانده از حافظه داخلی است. یعنی چنانچه حافظه داخلی پر شده و کارت حافظه هم روی دستگاه موجود باشد، به احتمال زیاد برنامه روی حافظه خارجی نصب خواهد شد.
همچنین بعد از نصب برنامه، کاربر می‌تواند در قسمت مدیریت برنامه‌ها در سیستم عامل خود، محل قرارگیری اپلیکیشن را از حافظه داخلی به خارجی و یا بلعکس تغییر دهد. اگر برنامه روی حافظه داخلی نصب شده باشد، کاربر می‌تواند با استفاده از گزینه Move to SD Card آنرا به حافظه خارجی دستگاه منتقل کند.
preferExternal: با تعریف این مقدار برای ویژگی installLocation در مانیفست پروژه اندرویدی، به سیستم عامل اعلام می‌کنیم که ترجیح (prefer) می‌دهیم اپ ما روی حافظه خارجی نصب شود. اما از واژه “ترجیح” می‌توان فهمید که ضمانتی در کار نیست و اینکه برنامه ما روی حافظه خارجی نصب شود یا داخلی باز هم به تصمیم سیستم عامل بستگی دارد.
برای مثال چنانچه حافظه خارجی ظرفیت لازم برای قرارگیری فایل برنامه را نداشته باشد، عمل نصب روی حافظه داخلی انجام خواهد شد.
internalOnly: همانطور که از نام آن پیداست، با تعیین این مقدار، امکان نصب اپلیکیشن فقط روی حافظه داخلی امکان پذیر خواهد بود و در آینده هم کاربر امکان انتقال آن به حافظه خارجی را نخواهد داشت.
بنابراین برای فعال کردن امکان نصب برنامه اندرویدی روی کارت حافظه لازم است مقدار preferExternal را انتخاب کنیم. لازم به تاکید است که ضمانتی در خصوص نصب برنامه روی حافظه خارجی وجود ندارد.

نکته: در برخی از موبایل‌ها یا تبلت‌های اندرویدی، قابلیت نصب برنامه روی حافظه خارجی حتی با وجود فعال بودن preferExternal در برنامه، توسط سازنده دستگاه غیر فعال شده و حتی پس از نصب روی حافظه داخلی هم امکان انتقال آن به حافظه خارجی وجود ندارد.
البته در تعدادی از دستگاه‌ها، در قسمت ویژه توسعه دهندگان (Developer Options) گزینه‌ای با نام Force allow apps on external وجود دارد که با فعال کردن آن، این امکان میسر خواهد بود:

اما توجه داشته باشید برای کاربران به عنوان مخاطب عام برنامه نمی‌توان روی این گزینه حساب کرد.

لازم به ذکر است با تعیین فضای خارجی به عنوان محل نصب برنامه، فقط فایل APK روی حافظه خارجی قرار گرفته و مابقی موارد مانند داده‌ها، دیتابیس برنامه و سایر موارد باز هم روی حافظه داخلی ذخیره می‌شود.

در چه مواردی نباید برنامه روی حافظه خارجی نصب شود؟

چنانچه به هر دلیلی حتی برای چند لحظه حافظه خارجی از دستگاه جدا شود، می‌تواند برخی از عملکردهای برنامه ما را تحت تاثیر قرار داده و باعث بروز مشکل شود.
برای مثال قبلا با کاربرد Service ها در اندروید آشنا شدیم. چنانچه در اپ از سرویس‌ها استفاده کرده باشیم، هنگام جدا شدن کارت حافظه از دستگاه، سرویس متوقف شده و با اتصال مجدد آن به دستگاه، سرویس به صورت خودکار مجدد راه اندازی نمی‌شود.
همچنین در صورت استفاده از AlarmManager در برنامه، با جدا شدن کارت حافظه آلارمی که توسط این متد ثبت کرده‌ایم لغو شده و با اتصال مجدد حافظه خارجی، به صورت خودکار فعال نخواهد شد.
به عنوان آخرین مثال، چنانچه بخواهیم با استفاده از Broadcast Receiver ها رویداد ACTION_BOOT_COMPLETED را شنود کنیم، با توجه به اینکه پیغام رویداد بوت شدن دستگاه قبل از شناسایی کارت حافظه توسط سیستم عامل ارسال می‌شود، امکان شنود این رویداد در برنامه ما فراهم نخواهد بود.
موفق و پیروز باشید

مطالعه‌ی بیشتر:

https://developer.android.com/guide/topics/data/install-location

نوشته فعال کردن امکان نصب برنامه روی کارت حافظه اولین بار در اندروید استودیو پدیدار شد.

محافظت از سورس برنامه اندرویدی و جلوگیری از دیکد

به نام خدا. قطعا عبارت “مهندسی معکوس” را بارها شنیده و خوانده‌اید. مهندسی معکوس یا Reverse Engineering در حوزه صنعت به اینصورت است که یک سخت افزار که قبلا توسط یک شخص/گروه/نهاد و یا دولت ساخته شده توسط شخص یا گروهی دیگر بررسی شده و نمونه مشابه آن با هزینه و صرف وقت کمتر تولید می‌شود.
اما این اتفاق صرفا محدود به ابزار صنعتی و نظامی نیست و در همه حوزه‌ها شاهد وقوع آن هستیم. از جمله در زمینه IT و نرم افزارهایی که برای پلتفرم‌ها و سیستم عامل‌های مختلف توسط گروه‌های متعددی منتشر شده‌اند.
قبلا در مبحث آشنایی با سیستم عامل اندروید گفتیم که برنامه‌های اندرویدی هم مانند هر پلتفرم دیگری برای آنکه قابلیت اجرا روی دستگاه را داشته باشد ابتدا باید کامپایل شوند. زمانی که ما از پروژه خود خروجی APK یا AAB در اندروید استودیو می‌گیریم عملیات کامپایل شدن سورس برنامه انجام می‌شود.
پس از Compile شدن پروژه اندرویدی، ساختار کدها دگرگون شده و کدها مانند قبل خوانا نیست اما نه به این معنی که قابل برگشت نباشد! برنامه‌های جاوا را می‌توان به سادگی دیکامپایل (Decompile) کرد. کافیست عبارت Java decompiler را در گوگل جستجو کنید.
دیکامپایل کردن برنامه‌های اندروید هم به همین سادگی انجام می‌شود. ابزار معروفی با نام JADX که به صورت رایگان و منبع باز در مخزن گیت هاب در دسترس همگان قرار دارد. حتی شخصی که بخواهد اپلیکیشن شما را دیکامپایل کند نیازی به راه اندازی JADX روی رایانه خود را نیز نداشته و در وب سایتی مانند javadecompilers.com می‌تواند فایل APK اپ را بارگزاری کرده و نسخه دیکد شده را در ظرف چند ثانیه تحویل بگیرد.
البته که نسخه دیکد شده‌ی دریافتی از JADX آماده ایمپورت در محیط توسعه اندروید استودیو نیست اما بهرحال کلاس‌ها و کدهای جاوا قابل دسترسی هستند و استفاده یا بهتر است بگوییم سوء استفاده از آنها را تسهیل می‌کند.
ضمن اینکه لازم به ذکر است با توجه به ماهیت زبان جاوا، ما هیچگاه نمی‌توانیم جلوی دیکد شدن کدها و کلاس‌های جاوا را بگیریم و صرفا باید سعی کنیم خوانایی و درک کدها پس از دیکد شدن برای افراد سخت تر شود. کدهای جاوا پس از دیکامپایل، به byte code ها تبدیل می‌شود نه کدهای native بنابراین دیکد کردن آن به سادگی امکانپذیر است.
در مواردی مانند پرداخت درون برنامه‌ای که اپلیکیشن کد یکتایی را از مارکت اندرویدی برای صحت سنجی سابقه خرید کاربر دریافت می‌کند، هکر می‌تواند این کد را غیر فعال کرده و بدون پرداخت هزینه به شما از امکانات برنامه استفاده کند.
بدترین اتفاق می‌تواند این باشد که شخصی برنامه شما را دیکامپایل کرده و با صرف هزینه و زمانی بسیار کمتر از آنچه شما بهایش را پرداخته‌اید، برنامه‌ای مشابه اپلیکیشن شما ساخته و با نام خودش در مارکت‌ها منتشر کند و حتی با نمایش تبلیغات و یا پرداخت درون برنامه‌ای به کسب درآمد بپردازد!
برای محافظت از سورس برنامه اندرویدی و جلوگیری از دیکد شدن کدهای جاوا و به عبارتی جلوگیری از دیکامپایل شدن اپ، روش‌ها و ابزار متعددی وجود دارد. برخی از ابزار رایگان و برخی دیگر نیاز به پرداخت هزینه لایسنس دارند. در این مبحث تنها به بررسی روش‌های رایج و ابزار رایگان می‌پردازیم و سایر موارد را صرفا به اشاره‌ای اکتفا خواهیم کرد.
Obfuscation به معنی مبهم سازی، اصلی ترین کاری است که به جهت محافظت از سورس برنامه اندرویدی و جلوگیری از دیکد شدن کدهای جاوا انجام می‌شود. در ادامه مبحث به طور مفصل به جزئیات می‌پردازیم.

پروگارد (ProGuard) چیست؟

اگر به محتویات فایل build.gradle (Module:App) پروژه‌های اندرویدی در اندروید استودیو دقت کرده باشید یک بلاک به صورت زیر به صورت پیش فرض وجود دارد:

buildTypes {
    release {
        minifyEnabled false
        proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
    }
}

فعال کردن ProGuard در اندروید استودیو بسیار ساده است. پروگارد در بیلد سیستم Gradle قرار داده شده و نیاز به نصب جداگانه ندارد. در حالت پیش فرض برای minifyEnabled مقدار false تعریف شده. این آیتم برای تعیین فعال یا غیر فعال بودن Proguard هنگام کامپایل شدن پروژه استفاده می‌شود. ترجمه تحت الفظی آن می‌شود “کوچک کردن فعال است”. چنانچه مقدار را به true تغییر دهیم، پروگارد فعال شده و هنگام گرفتن خروجی پروژه (release یا debug) وظایف خودش را انجام خواهد داد.
در خط دوم، فایل تنظیمات و قوانین پیش فرض پروگارد توسط proguardFiles تعیین شده است.

ProGuard چه وظایفی را بر عهده دارد؟

در صورت فعال کردن پروگارد در پروژه اندرویدی در اندروید استودیو، سه عمل در هنگام کامپایل شدن انجام می‌شود که به شرح زیر می‌باشد:
مبهم سازی نام‌ها یا Name obfuscation: تغییر نام کلاس‌ها، فیلدها و متدها با نام‌های کوتاه و عموما یک کاراکتری. برای مثال ممکن است نام کلاس Users به a تغییر پیدا کند که علاوه بر کاهش تعداد کاراکترهای نام کلاس هنگام فراخوانی و به دنبال آن کاهش حجم نهایی کدها، خوانایی، درک و تشخیص کدها را تا حدود زیادی مشکل می‌کند.
Shrinking یا Tree shaking: این قابلیت باعث می‌شود تا کلاس‌ها، متدها، فیلدها، ویژگی‌ها (attributes) و کتابخانه‌های بلا استفاده درون پروژه هنگام کامپایل حذف شوند که باز هم کاهش حجم نهایی اپ را بدنبال خواهد داشت. بنابراین این قابلیت به بهینه شدن و افزایش سرعت اجرای برنامه روی دستگاه کاربر کمک می‌کند.
بهینه سازی کد یا Code optimization: در هر دو مورد قبل عمل بهینه کردن کدها انجام می‌شد اما هنوز هم برای کمتر شدن حجم کدها جای کار هست. وظیفه دیگر پروگارد بهینه کردن کدهای جاوا است. به عبارت دیگر، کدها بازنویسی می‌شوند تا در حد امکان تعداد کاراکترها و دستورات کاهش یافته و حجم فایل DEX اپ به کمترین میزان ممکن برسد.
به عبارتی کدها Minify می‌شوند. درست مانند آنچه در Minify کردن کدهای CSS صفحات وب اتفاق می‌افتد. هنگام Minify کردن یک کد CSS عملیاتی مانند حذف فاصله‌های اضافی و کامنت‌ها انجام می‌شود. همچنین برای مثال اگر برای یک قسمت از صفحه وب، رنگ #FFFFFF تعریف شده باشد، آنرا به #FFF تغییر می‌دهد. همین تغییرات کوچک و به ظاهر غیر ضرور، در نهایت حجم قابل توجهی از فایل نهایی CSS را کاهش می‌دهد.
برای مثال اگر در بخشی از پروژه اندرویدی یک if/else تعریف کرده باشیم و پروگارد تشخیص دهد بلاک else{} هیچگاه اجرا نخواهد شد، آنرا از خروجی برنامه حذف می‌کند. یا مثلا اگر متدی تعریف کرده باشیم که فقط از یک جا فراخوانی می‌شود، پروگارد آنرا حذف کرده و به صورت inline در محل کد اصلی جایگزین می‌کند.
به این ترتیب درصدی از کدهای اضافی پروژه اندرویدی ما حذف شده که علاوه بر کاهش حجم نهایی فایل APK یا AAB برنامه، با بهینه شدن دستورات و کلاس‌های جاوا، سرعت اجرای برنامه می‌تواند افزایش یابد. پروگارد می‌تواند تا ۵۰% از حجم بایت کدهای اپلیکیشن اندرویدی را کاهش دهد.
خب! تا حد زیادی با ProGuard و کاربردهای آن آشنا شدیم. اما لازم است بگویم که پس از انتشار Android Gradle plugin 3.4.0 و همزمان با انتشار Android studio 3.3 beta (در ماه April سال ۲۰۱۹) جایگزینی جدید با نام R8 توسط توسعه دهندگان اندروید استودیو برای ProGuard معرفی شد. این ابزار جدید نسبت به نسخه قبلی برتریی‌هایی را داشته و خروجی بهینه تری را برای ما رقم می‌زند. البته جای هیچ نگرانی نیست زیرا طریق فعالسازی و استفاده آن تفاوتی با پروگارد ندارد.
در واقع R8 از ترکیب و ادغام ProGuard با ابزار دیگر ساخته شده و از قوانین آن پیروی می‌کند. در ادامه بیشتر با R8 آشنا می‌شویم.

ابزار R8 جایگزینی شایسته برای ProGuard

همانطور که قبلا اشاره شد، با انتشار پلاگین گریدل نسخه ۳٫۴٫۰ برای اندروید استودیو، ابزار معروف ProGuard بازنشسته شد و جای خود را به ابزاری تازه نفس و قدرتمندتر به نام R8 داد. ابزار R8 نسبت به پروگارد، عملیات بهینه سازی را با سرعت بالاتری انجام داده و علاوه بر آن، درصد بهینه سازی و کاهش حجم فایل نصبی برنامه نیز افزایش می‌دهد.
شاید بهتر باشد مزایای R8 را نسبت به ProGuard به صورت دقیق‌تر و با جزئیات بیشتری بررسی کنیم.

مقایسه R8 با ProGuard

لازم می‌دانم از کلی گویی اجتناب کرده و تفاوت‌های این دو را به لحاظ فنی و دقیق برای شما تشریح کنم تا درک بهتری از تصمیم گوگل برای جایگزینی R8 داشته باشید. البته عنوان مقایسه خیلی برای این قسمت کامل نیست. می‌خواهم تاریخچه آنچه در طی این چند سال توسعه دهندگان اندروید را از ProGuard به R8 رسانده بیان کنم.
در گذشته روش کار به اینصورت بود که کامپایلر جاوا، سورس کدهای جاوای پروژه اندرویدی را به بایت کد (Bytecode) های جاوا تبدیل می‌کرد. سپس این بایت کدها توسط ProGuard بهینه شده و بایت کدهای بهینه‌ای ایجاد می‌شد که سریعتر و کم حجم تر بودند. در نهایت، کامپایلر DX این بایت کدها را به بایت کدهای ویژه ماشین مجازی دالویک (Dalvik) تبدیل می‌کرد. قبلا در مبحث آشنایی با سیستم عامل اندروید با کاربرد ماشین‌های مجازی Dalvik و ART آشنا شدیم.

این بایت کد که با فرمت .dex در پکیج فایل نصبی APK نگهداری می‌شود بسته به نسخه سیستم عامل اندروید دستگاه کاربر، توسط ماشین مجازی Dalvik یا ART و یا ترکیبی از هردو (مانند Android P) به زبان قابل فهم برای ماشین ترجمه می‌شد.
این فرآیند قدری زمان بر بود و در سال ۲۰۱۵ تیم توسعه اندروید تصمیم گرفت کامپایلر جدیدی را جایگزین کند تا مراحل کامپایل کاهش یابد. بنابراین کامپایلری با نام Jack & Jill معرفی شد.

در واقع این کامپایلر ترکیبی از کامپایلر جاوا، پروگارد و کامپایلر دالویک بود و دستورات و توابع هرسه در یک مرحله انجام می‌شد که نتیجه آن افزایش سرعت کامپایل پروژه اندرویدی بود. اما Jack & Jill هم خالی از ایراد نبود و در تعامل با برخی بایت کدهای Java مشکلاتی داشت. به همین دلیل تیم توسعه اندروید این کامپایلر را در سال ۲۰۱۷ کنار گذاشت.
سپس کامپایلر دیگری با نام D8 جایگزین شد که از حیث تعداد مراحل تفاوتی با حالت اول نداشت و صرفا در مرحله آخر، D8 جایگزین DX شده بود.

کامپایلر D8 سازگاری بیشتر بخصوص با کاتلین داشت. علاوه بر آن بایت کدهای کمتر و بهینه تری را تولید می‌کرد.
در نهایت R8 معرفی شد که از ادغام ProGuard و D8 بوجود آمده است.

در حال حاضر، بایت کدهای جاوا مستقیما توسط کامپایلر R8 به بایت کدهای بهینه دالویک تبدیل می‌شوند. مراحل کمتر، بهینه بودن و سازگاری بیشتر با نیازهای جدید.

مزایای کامپایلر R8

از مهمترین دلایلی که گوگل را مجاب کرد تا ابزار کامپایلر R8 را جایگزین ProGuard در اندروید استودیو کند می‌توان به موارد زیر اشاره کرد:
بهینه سازی بیشتر: R8 در مقایسه با ProGuard بهینه سازی و Minification عمیق‌تری انجام می‌دهد که نتیجه آن فشرده شدنِ بیشترِ نسخه خروجی یعنی فایل APK است. به عبارتی می‌توانیم چند درصد دیگر هم کاهش حجم را هنگام کامپایل کردن پروژه اندرویدی خود شاهد باشیم.
بر اساس تست‌هایی که انجام شده R8 حتی می‌تواند تا ۷۰ درصد از حجم برنامه را نسبت به حالت عادی فشرده‌تر کند که یک خروجی فوق العاده به حساب می‌آید. حتی ۱ درصد کاهش حجم بخصوص در برنامه‌های با حجم بالا می‌تواند در تسریع دسترسی کاربران به اپلیکیشن هنگام دریافت آن از مارکت‌ها و همچنین اجرای برنامه روی دستگاه نقش موثری داشته باشد.
سازگاری بیشتر با Kotlin: با پشتیبانی رسمی محیط توسعه اندروید استودیو از زبان محبوب کاتلین در نسخه‌های جدید، سازگاری هرچه بیشتر کامپایلر با کدهای Kotlin ضروری بود. R8 این ویژگی را دارد و در بهینه کردن کدهایی که به زبان کاتلین نوشته شده‌اند بازدهی بالاتری نسبت به پروگارد دارد.
خروجی بهتر: R8 خروجی بهتری نسبت به پروگارد به ما تحویل می‌دهد. علاوه بر آن، سرعت بیلد شدن پروژه نیز به نسبت قبل مقداری کاهش می‌یابد.

فعال کردن ProGuard / R8 در اندروید استودیو

به اندازه کافی در خصوص پروگارد و جایگزین جدید آن یعنی R8 به تئوریات پرداختیم. بهتر است روش فعالسازی و همچنین جزئیات آن را بررسی کنیم. البته در اینجا می‌خواهیم خروجی پروژه را قبل و بعد از فعال کردن R8 بررسی کنیم تا نتیجه کار را در عمل ببینیم.
مطابق مبحث آموزش ساخت پروژه در اندروید استودیو یک پروژه اندرویدی با نام My Application می‌سازم. اکتیویتی را از نوع Empty Activity و زبان را Java انتخاب کردم.
یک متغیر از نوع String درون اکتیویتی پیش فرض پروژه تعریف می‌کنم:

MainActivity.java

package com.example.myapplication;

import androidx.appcompat.app.AppCompatActivity;
import android.os.Bundle;

public class MainActivity extends AppCompatActivity {

    String myString;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        myString = "android-studio.ir";

    }
}

از مسیر Build > Generate Signed Bundle/APK یک خروجی APK از پروژه می‌گیرم.
بعد از ساخته شدن فایل، آنرا تغییر نام می‌دهم تا از خروجی دوم قابل تشخیص باشد. حالا فایل build.gradle (app) پروژه را باز کرده و در بلاک release برای minifiEnabled مقدار true را جایگزین false می‌کنم:

buildTypes {
    release {
        minifyEnabled true
        proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
    }
}

android.enableR8=true

مجدد یک خروجی APK از پروژه می‌سازم:

در تصویر بالا مشاهده می‌کنید حجم فایل APK که در مرحله اول ساخته شده ۲۲۲۱ کیلوبایت است در صورتی که فایل دوم ۱۴۷۰ کیلوبایت حجم دارد. یعنی با فعال شدن R8 در حین کامپایل برنامه چیزی حدود ۳۰ درصد از حجم فایل نصبی برنامه کاهش یافت.
اما همانطور که مفصل بحث کردیم، در کنار بهینه سازی کدها و کاهش حجم نهایی، یک وظیفه دیگر هم بر عهده R8 هست؛ یعنی همان مبهم سازی کدهای جاوا به جهت محافظت از سورس برنامه اندرویدی که در نهایت باعث جلوگیری از دیکد شدن کلاس‌ها، متدها و فیلدها می‌شود.
البته لازم به تکرار است وقتی صحبت از جلوگیری از دیکامپایل شدن اپ می‌کنیم منظور سخت کردن فرایند است وگرنه بطور کامل نمی‌توان از دیکد کردن جاوا و دیکامپایل شدن اپلیکیشن اندرویدی جلوگیری کرد.
برای تست و بررسی فعال شدن R8 در پروژه، هردو فایل APK را توسط APK Decompiler بصورت آنلاین دیکامپایل می‌کنم. این سرویس رایگان و آنلاین از JADX برای دیکامپایل کردن فایل dex موجود در پکیج برنامه اندرویدی و تبدیل آن به کلاس‌های Java استفاده می‌کند.

کافیست فایل apk را انتخاب کرده و روی گزینه Upload and Decompile کلیک کنم تا در ظرف مدت چند ثانیه فایل zip سورس برنامه را تحویل دهد!

این کار را برای هردو فایل انجام می‌دهم. فایل‌های zip را باز کرده و بررسی می‌کنم. برای مثال تفاوت کلاس MainActivity به ترتیب، قبل و بعد از فعال شدن R8 به اینصورت است:

package com.example.myapplication;

import android.os.Bundle;
import androidx.appcompat.app.AppCompatActivity;

public class MainActivity extends AppCompatActivity {
    String myString;

    /* access modifiers changed from: protected */
    public void onCreate(Bundle bundle) {
        super.onCreate(bundle);
        setContentView((int) C0400R.layout.activity_main);
        this.myString = "android-studio.ir";
    }
}

package com.example.myapplication;

import android.os.Bundle;
import p002b.p004b.p005c.C0149h;

public class MainActivity extends C0149h {
    public void onCreate(Bundle bundle) {
        super.onCreate(bundle);
        setContentView((int) R.layout.activity_main);
    }
}

ملاحظه می‌کنید علاوه بر حذف خط کامنت از کلاس، نام کلاس کتابخانه

androidx.appcompat.app.AppCompatActivity

به

p002b.p004b.p005c.C0149h

تغییر یافته. همچنین String ای که داخل اکتیویتی تعریف شده بود نیز حذف شده زیرا R8 تشخیص داده که این متغیر بلا استفاده بوده و در هیچ قسمتی از برنامه فراخوانی نشده است.
نتیجه‌ی این تغییر، کاهش حجم کد از ۴۲۵ کاراکتر به ۲۷۵ کاراکتر و همچنین سخت شدن درک کدها شده است.

فشرده سازی بیشتر با فعال کردن fullMode در R8

اما R8 هنوز هم می‌تواند اپلیکیشن ما را فشرده تر کند. کافیست در فایل gradle.properties خط زیر را اضافه کنیم:

android.enableR8.fullMode=true

توجه داشته باشید این فایل مختص پروژه فعلی نیست و تنظیمات آن در همه‌ی پروژه‌های شما اعمال می‌شود. بنابراین اگر در پروژه دیگری نیاز به فعالسازی fullMode نباشد لازم است این خط را حذف یا کامنت کنیم.

مجددا یک خروجی APK از پروژه می‌گیرم تا تفاوت حجم برنامه قبل و بعد از فعال کردن حالت fullMode را ارزیابی کنیم:

مشاهده می‌کنید بازهم حدود ۱۰۰ کیلوبایت از حجم نهایی اپلیکیشن کاسته شد. به عبارت دیگر با فعال کردن R8 و همچنین حالت fullMode حدود ۴۰ درصد کاهش حجم را در خروجی پروژه شاهد بودیم. البته این اعداد ثابت نیست و بسته به مقدار کدها، تعداد کتابخانه‌های بکار رفته در پروژه، منابع موجود در پروژه مانند تصاویر، فایل‌های صوتی و… متغیر خواهد بود.

تعریف قوانین سفارشی در R8

با فعال کردن ProGuard/R8 در پروژه اندرویدی، هرسه عملکردی که قبلا به آنها اشاره کردیم روی سورس پروژه شامل کلاس‌ها، متدها و فیلدها اعمال می‌شوند. اما گاهی اوقات لازم است یک آیتم را به عنوان استثناء در R8 تعریف کنیم تا هیچگونه تغییری روی آن انجام نگردد.
برای مثال در آموزش کار با کتابخانه Retrofit که شامل یک فرم عضویت بود و اطلاعات شخص شامل نام، نام کاربری و رمز عبور به سرور ارسال می‌شد، نام متغیرهای ارسالی نباید دچار هیچگونه تغییراتی شود در غیر اینصورت اطلاعات عضویت شخص در دیتابیس ثبت نخواهد شد.
اما راهکار چیست؟ آیا به دلیل جلوگیری از بروز اشکال در یک کتابخانه یا کلاس یا تابع باید از بهینه کردن و محافظت از سورس برنامه اندرویدی و جلوگیری از دیکامپایل شدن اپ چشم پوشی کنیم؟ خیـــــر!
در ProGuard و جایگزین آن یعنی R8 قابلیتی در اختیار توسعه دهنده و برنامه نویس اندرویدی قرار گرفته که می‌تواند برای آیتم‌های خاص استثناء قائل شد تا بدون هیچگونه مبهم سازی و یا بهینه سازی در نسخه کامپایل شده برنامه قرار گیرند.
دوباره به بلاک release دقت کنید:

buildTypes {
    release {
        minifyEnabled true
        proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
    }
}

قوانین و عملکردهای پایه و پیش فرض پروگارد (R8) توسط getDefaultProguardFile از فایلی با نام proguard-android-optimize.txt خوانده می‌شود. اما چنانچه بخواهیم استثنائی در قوانین تعریف کنیم نیازی به ویرایش فایل پیش فرض نیست و لازم است قوانین اختصاصی پروژه را در فایل proguard-rules.pro اضافه کنیم.
این فایل در کنار سایر فایل‌های زیر مجموعه Gradle قرار دارد:

این فایل به صورت پیش فرض دارای هیچ قانون فعالی نیست و صرفا چند خط توضیحات به صورت کامنت قید شده است. البته در بین توضیحات، چند مورد از قوانین پر کاربرد هم ذکر شده که در صورت نیاز کافیست از حالت کامنت خارج شود:

proguard-rules.pro

# Add project specific ProGuard rules here.
# You can control the set of applied configuration files using the
# proguardFiles setting in build.gradle.
#
# For more details, see
#   http://developer.android.com/guide/developing/tools/proguard.html

# If your project uses WebView with JS, uncomment the following
# and specify the fully qualified class name to the JavaScript interface
# class:
#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
#   public *;
#}

# Uncomment this to preserve the line number information for
# debugging stack traces.
#-keepattributes SourceFile,LineNumberTable

# If you keep the line number information, uncomment this to
# hide the original source file name.
#-renamesourcefileattribute SourceFile

برای مثال چنانچه بخواهیم از WebView در برنامه خود استفاده کنیم و صفحه وب موردنظر حاوی کدهای JS (جاوا اسکریپت) باشد، قانونی که بعد از توضیحات مربوط به وب ویو قرار گرفته را از حالت کامنت خارج می‌کنیم:
# If your project uses WebView with JS, uncomment the following
# and specify the fully qualified class name to the JavaScript interface
# class:
-keepclassmembers class fqcn.of.javascript.interface.for.webview {
   public *;
}

معمولا کتابخانه‌هایی که نیاز به تعریف قوانین اختصاصی دارند توضیحات لازم را در صفحه معرفی خود قید می‌کنند. از جمله Retrofit:

ملاحظه می‌کنید در قسمت توضیحات مربوط به قوانین R8 / ProGuard سه لینک ذکر شده که مربوط به قوانین Retrofit و OkHttp و Okio هستند. از آنجایی که کتابخانه‌های OkHttp و Okio در داخل کتابخانه Retrofit قرار دارند، لازم است قوانین هرسه مورد به پروژه اضافه شود.
من برای بررسی بیشتر قوانین، موارد مربوط به خود رتروفیت را اضافه می‌کنم:

proguard-rules.pro

# Add project specific ProGuard rules here.
# You can control the set of applied configuration files using the
# proguardFiles setting in build.gradle.
#
# For more details, see
#   http://developer.android.com/guide/developing/tools/proguard.html

# If your project uses WebView with JS, uncomment the following
# and specify the fully qualified class name to the JavaScript interface
# class:
-keepclassmembers class fqcn.of.javascript.interface.for.webview {
   public *;
}

# Uncomment this to preserve the line number information for
# debugging stack traces.
#-keepattributes SourceFile,LineNumberTable

# If you keep the line number information, uncomment this to
# hide the original source file name.
#-renamesourcefileattribute SourceFile
# Retrofit does reflection on generic parameters. InnerClasses is required to use Signature and
# EnclosingMethod is required to use InnerClasses.
-keepattributes Signature, InnerClasses, EnclosingMethod

# Retrofit does reflection on method and parameter annotations.
-keepattributes RuntimeVisibleAnnotations, RuntimeVisibleParameterAnnotations

# Retain service method parameters when optimizing.
-keepclassmembers,allowshrinking,allowobfuscation interface * {
    @retrofit2.http.* <methods>;
}

# Ignore annotation used for build tooling.
-dontwarn org.codehaus.mojo.animal_sniffer.IgnoreJRERequirement

# Ignore JSR 305 annotations for embedding nullability information.
-dontwarn javax.annotation.**

# Guarded by a NoClassDefFoundError try/catch and only used when on the classpath.
-dontwarn kotlin.Unit

# Top-level functions that can only be used by Kotlin.
-dontwarn retrofit2.KotlinExtensions
-dontwarn retrofit2.KotlinExtensions$*

# With R8 full mode, it sees no subtypes of Retrofit interfaces since they are created with a Proxy
# and replaces all potential values with null. Explicitly keeping the interfaces prevents this.
-if interface * { @retrofit2.http.* <methods>; }
-keep,allowobfuscation interface <1>

اگر این قوانین برایتان مبهم بنظر می‌رسند جای نگرانی نیست؛ در اینجا به موارد پر کاربرد اشاره می‌کنیم.

قوانین R8 / ProGuard

مهمترین قوانین R8/ProGuard را به طور مختصر توضیح می‌دهم:
-keepattributes: ویژگی‌هایی که توسط این قانون تعریف شوند بدون تغییر باقی می‌مانند.
-keep: توسط این دستور می‌توان یک کلاس و متدها و فیلدهای داخل آن را به عنوان استثناء تعریف کرد تا عملکردهای R8 روی آن پیاده نشود.
-keepclassmembers: متدها و فیلدهای موردنظر داخل یک کلاس را می‌توان به عنوان استثناء تعریف نمود.
-keepnames: از تغییر نام کلاس یا متدها و فیلدهای مدنظر جلوگیری می‌کند.
-dontwarn: تعیین می‌کند که هیچگونه هشداری در مورد ارجاعاتی (References) که در کلاس مدنظر ذکر شده و ProGuard/R8 آن را پیدا نمی‌کند و یا سایر خطاها، داده نشده و از آنها عبور کند.
-dontshrink: این قانون، قابلیت Shrink یعنی حذف آیتم‌های بلا استفاده را غیر فعال می‌کند و صرفا دو عمل دیگر یعنی بهینه سازی (Optimization) و مبهم سازی (Obfuscation) برای آن انجام می‌شود.
-dontoptimize: مانند مورد قبل با این تفاوت که فقط عمل بهینه سازی انجام نمی‌شود.

قوانین پروگارد گسترده تر از چند موردی است که در اینجا اشاره شد. برای مطالعه لیست کامل قوانین و همچنین توضیحات بیشتر به وب سایت آن در صفحه ProGuard Reference card مراجعه کنید.

ابزار و روش‌های دیگر جهت محافظت از سورس برنامه اندرویدی

تا اینجا توانستیم با استفاده از ابزار داخلی و رایگان اندروید استودیو تا حد زیادی عمل مبهم سازی و بهینه سازی فایل APK را انجام دهیم. اما جلوگیری از دیکد شدن سورس کد برنامه اندرویدی محدود به همین R8 نیست.
R8 یا ProGuard می‌تواند عملیات مبهم سازی را بر روی کلاس‌ها، فیلدها و متدها پیاده سازی کرده تا درک کدها و سوء استفاده از آنها به راحتی امکان پذیر نباشد. اما این ابزار String ها را بدون تغییر باقی می‌گذارد که در مواردی می‌تواند امنیت برنامه ما را بخطر بیندازد.
برای مثال چنانچه اپلیکیشن شما به یک سرور یا API وابسته است و اطلاعاتی بین آنها ردوبدل می‌شود، در صورتی که آدرس (URL) وب سرویس یا API رمزگذاری (Encrypt) نشده باشد هکر می‌تواند با دیکامپایل کردن برنامه به URL یا کلیدهای خصوصی مربوط به API دسترسی پیدا کرده و از آنها برای مقاصد خود استفاده کند.
چنانچه به قابلیت رمزگذاری رشته‌های متنی برای اپ خود نیاز داشته باشیم لازم است از جایگزین‌های R8 استفاده کرده یا ابزار دیگری را در کنار آن اضافه کنیم.
برای مثال شرکت سازنده ProGuard یعنی GuardSquare یک ابزار دیگر با نام DexGuard را معرفی کرده که امکانات بیشتری نسبت به پروگارد را در اختیار برنامه نویسان اندرویدی قرار می‌دهد. یکی از امکانات دکس گارد رمزگذاری String هاست. البته این ابزار بر خلاف پروگارد رایگان نبوده و باید لایسنس آن خریداری شود.
اما بر خلاف DexGuard که باید جایگزین ProGuard/R8 شود و رایگان هم نیست، پلاگین‌هایی هستند که رایگان بوده و در کنار R8 و به عنوان مکمل استفاده می‌شوند. از جمله پلاگین Enigma یا StringCare که هردو رایگان هستند.
البته نوشتن کدهای حساس و مهم برنامه به صورت native به زبان C/C++ هم می‌تواند فرایند مهندسی معکوس را به مراتب دشوار تر از قبل کند. با استفاده از ابزار NDK می‌توانید کدهای نیتیو خود را در قالب فایل‌های .so به پروژه اندرویدی اضافه کنید.
پرداختن به این ابزار از حوصله این مبحث خارج بوده و صرفا به ذکر نام آنها اکتفا می‌کنم. به امید خدا در آموزش‌های آتی به معرفی کامل و نحوه فعالسازی یکی از آنها خواهیم پرداخت.
موفق و پیروز باشید.

مطالعه‌ی بیشتر:

https://www.guardsquare.com/en/blog/proguard-and-r8
https://www.guardsquare.com/en/blog/comparison-proguard-vs-r8-october-2019-edition
https://developer.android.com/studio/build/shrink-code
https://www.guardsquare.com/en/blog/dexguard-vs-proguard
https://blog.mindorks.com/applying-proguard-in-an-android-application
https://android-developers.googleblog.com/2018/11/r8-new-code-shrinker-from-google-is.html

نوشته بهینه کردن و محافظت از سورس برنامه با ProGuard/R8 اولین بار در اندروید استودیو پدیدار شد.

در چه مواردی به بررسی نصب بودن برنامه در اندروید نیاز داریم؟

به نام خدا. گاهی اوقات بخشی از فرایندهای موجود در اپلیکیشن ما به یک یا چند برنامه دیگر وابسته است که در صورت نصب نبودن برنامه موردنظر روی دستگاه اندرویدی کاربر، می‌تواند سبب بروز اختلال در عملکرد برنامه ما گردد.
فرض کنید قصد توسعه و برنامه نویسی اپلیکیشنی را دارید که بخشی از امکانات آن با پرداخت درون برنامه‌ای از طریق مارکت‌های اندرویدی فعال می‌شود. در اینجا چنانچه مارکت موردنظر شما (مانند بازار، مایکت و…) روی دستگاه کاربر از قبل نصب و فعال نشده باشد، عملیات پرداخت ناتمام مانده و برنامه کرش خواهد کرد.
برای حل این مشکل لازم است شرطی را در برنامه تعریف کنیم که قبل از شروع فرایند پرداخت درون برنامه‌ای، بررسی کند صرفا در صورتی این عملیات آغاز شود که مارکت با Package name مدنظر ما روی دستگاه موجود باشد و چنانچه موجود نبود، پیغامی با این مضمون را به کاربر نمایش داده و یا به صفحه دانلود مارکت هدایت شود.
به عنوان یک مثال دیگر، شرکت ارائه دهنده تاکسی آنلاین را درنظر بگیرید که دارای دو اپلیکیشن اندرویدی است. یک برنامه مخصوص مسافران و دیگری ویژه‌ی رانندگان.
قصد داریم در هردو برنامه گزینه‌ای برای انتقال به برنامه دیگر اضافه کنیم به طوری که اگر در اپ ویژه‌ی مسافر، روی گزینه موردنظر کلیک شد، اپ ویژه راننده اجرا شده و بلعکس. و البته اینکه چنانچه برنامه دوم روی دستگاه نصب نبود، پیغام متناسب با آن نمایش داده شده و یا کاربر به صفحه نصب آن در مارکت یا مرورگر هدایت شود.
کاربردهای متعدد دیگری هم برای این قابلیت وجود دارد که در اینجا تنها به دو مورد اکتفا می‌کنم.
در ادامه مبحث در قالب یک پروژه ساده، این قابلیت را بررسی و تمرین می‌کنیم.

ساخت پروژه بررسی نصب بودن برنامه اندرویدی

طبق مبحث آموزش ساخت پروژه در اندروید استودیو یک پروژه اندرویدی با نام App installed می‌سازم. اکتیویتی را از نوع Empty Activity و زبان را Java انتخاب کردم.
ابتدا نحوه بررسی نصب بودن برنامه در اندروید را به دو روش متفاوت انجام و در مرحله آخر نیز فراخوانی مارکت و یا باز کردن لینک صفحه دانلود برنامه را بررسی می‌کنیم.

روش اول: استفاده از متد getPackageInfo

در روش نخست، با استفاده از متد getPackageInfo و دستور try catch در لیست برنامه‌های نصب شده روی دستگاه اندرویدی نام پکیج برنامه مدنظر را جستجو می‌کنیم. چنانچه نام پکیج یا همان Package name موردنظر موجود بود کدهای درون بلاک try و در غیر اینصورت قسمت catch اجرا خواهد شد:

private boolean installedOrNot(Context cnt, String packageName) {

    PackageManager pm = cnt.getPackageManager();
    boolean appInstalled;

    try {
        pm.getPackageInfo(packageName, PackageManager.GET_ACTIVITIES);
        appInstalled = true;
        Toast.makeText(cnt, "برنامه قبلا نصب شده است", Toast.LENGTH_LONG).show();
    } catch (PackageManager.NameNotFoundException e) {
        appInstalled = false;
        Toast.makeText(cnt, " برنامه قبلا نصب نشده است ", Toast.LENGTH_LONG).show();
    }
    return appInstalled;

}

مطابق با کد فوق ابتدا یک متد از جنس boolean و با نام دلخواه installedOrNot درون اکتیویتی و بعد از متد onCreate تعریف کرده‌ام. این متد دو پارامتر دارد که اولی کانتکست و دومی از جنس رشته تعریف شده.
درون این متد ابتدا یک شیء از کلاس PackageManager با نام دلخواه pm ساخته شده است. سپس یک متغیر از جنس boolean با نام appInstalled تعریف شده.
داخل بلاک try و با استفاده از متد getPackageInfo نام پکیج بررسی می‌شود. چنانچه پکیج و به عبارتی اپلیکیشن مدنظر قبلا نصب شده باشد، متغیر appInstalled مقدار true گرفته و کدهای بعد از آن اجرا می‌شود که من در اینجا یک پیغام Toast تعریف کردم.
برای بلاک catch یک Exception (استثناء) از نوع PackageManager.NameNotFoundException تعریف شده که از نامش پیداست مربوط به پیدا نشدن نام است (NameNotFound). یعنی هنگامی که نام پکیج یافت نشد این استثناء اجرا می‌شود که در اینصورت مقدار false برای متغیر appInstalled در نظر گرفته شده و مانند قسمت قبل یک پیغام برای کاربر ظاهر می‌شود که اعلام می‌کند برنامه مدنظر نصب نشده است.
در نهایت از آنجایی که تابع از جنس boolean بود لازم است appInstalled را return کنیم.
حالا متد را در onCreate تعریف می‌کنم:

installedOrNot(getApplicationContext(), "com.farsitel.bazaar");

پارامتر نخست مربوط به کانتکست است که قبلا آشنا شدیم و نیاز به توضیح مجدد نیست. برای پارامتر دوم نام پکیج موردنظرم را در قالب یک String وارد می‌کنم. من Package name مارکت ایرانی بازار را تعریف کرده‌ام. تا اینجای کار اکتیویتی ما به صورت زیر تکمیل شده است:

MainActivity.java

package ir.android_studio.appinstalled;

import androidx.appcompat.app.AppCompatActivity;

import android.content.Context;
import android.content.pm.PackageManager;
import android.os.Bundle;
import android.widget.Toast;

public class MainActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        installedOrNot(getApplicationContext(), "com.farsitel.bazaar");

    }

    private boolean installedOrNot(Context cnt, String packageName) {

        PackageManager pm = cnt.getPackageManager();
        boolean appInstalled;

        try {
            pm.getPackageInfo(packageName, PackageManager.GET_ACTIVITIES);
            appInstalled = true;
            Toast.makeText(cnt, "برنامه قبلا نصب شده است", Toast.LENGTH_LONG).show();
        } catch (PackageManager.NameNotFoundException e) {
            appInstalled = false;
            Toast.makeText(cnt, "برنامه قبلا نصب نشده است", Toast.LENGTH_LONG).show();
        }
        return appInstalled;

    }

}

خب! پروژه را اجرا و تست می‌کنیم:

به محض اجرای برنامه روی شبیه ساز، پیغام “برنامه قبلا نصب نشده است” مشاهده شد. یعنی اپلیکیشن بازار روی این دیوایس نصب نیست.
حالا برنامه بازار را روی دستگاه نصب کرده و مجدد پروژه را اجرا می‌کنم:

برخلاف قسمت قبل اینبار پیغام “برنامه قبلا نصب شده است” ظاهر شد. بنابراین کد ما به درستی عمل می‌کند.
برای مثال پرداخت درون برنامه‌ای که در ابتدای مبحث عنوان شد، بجای Toast اول می‌توانیم عملیات مربوط به انتقال به مارکت و ثبت تراکنش مالی توسط کاربر را انجام دهیم. همچنین بجای Toast دوم هم می‌توان کاربر را به صفحه دانلود مارکت هدایت کرد یا اینکه در قالب همین پیغام اعلام شود لازم است مارکت x روی دستگاه نصب شود. این بخش را نیز در انتهای مبحث بررسی می‌کنیم.

روش دوم: استفاده از intent

قبلا در جلسه آموزش intent در اندروید با اینتنت‌ها آشنا شدیم. در این روش با استفاده از intent، نام پکیج کلیه برنامه‌های نصب شده روی دستگاه اندرویدی را در یک لیست ذخیره کرده و سپس پکیج موردنظر را درون آن لیست جستجو می‌کنیم.
ابتدا کد مربوط به قسمت قبل را کامنت می‌کنم تا غیر فعال شود. سپس دو متد به صورت زیر به اکتیویتی اضافه می‌کنم:

protected List<String> getInstalledAppsPackage() {

    Intent mIntent = new Intent(Intent.ACTION_MAIN, null);
    mIntent.addCategory(Intent.CATEGORY_LAUNCHER);
    mIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK|Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
    List<ResolveInfo> resolveInfoList = getPackageManager().queryIntentActivities(mIntent, 0);
    List<String> packageNameList = new ArrayList<>();

    for (ResolveInfo resolveInfo: resolveInfoList) {
        ActivityInfo actInfo = resolveInfo.activityInfo;
        packageNameList.add(actInfo.applicationInfo.packageName);
    }

    return packageNameList;

}

private void appStatus() {

    final List<String> installedPackages = getInstalledAppsPackage();

    if (installedPackages.contains(mPackageName)) {
        Toast.makeText(this, "برنامه قبلا نصب شده است", Toast.LENGTH_LONG).show();
    } else {
        Toast.makeText(this, "برنامه قبلا نصب نشده است", Toast.LENGTH_LONG).show();
    }

}

ملاحظه می‌کنید ابتدا یک تابع از جنس List و نام دلخواه getInstalledAppsPackage تعریف شده. درون این تابع، اکتیویتی لانچر هر یک از برنامه‌های نصب شده روی دستگاه توسط Intent.CATEGORY_LAUNCHER مشخص می‌شود. سپس Package name آنها توسط actInfo.applicationInfo.packageName موجود در حلقه for، دریافت و به لیست packageNameList اضافه (add) می‌گردد.
در ادامه کار یک متد دیگر با نام دلخواه appStatus تعریف شده که درون آن بررسی می‌کنیم آیا این لیست شامل mPackageName ای که تعریف کرده‌ایم هست (contains) یا نه. چنانچه این شرط برقرار بود، پیغام نصب و در غیر اینصورت پیغام عدم نصب نمایش داده خواهد شد.
در نهایت، متد appStatus را در onCreate فراخوانی می‌کنم.
برای تست این کد، نام پکیج مربوط به پلیر VLC را در بدنه اکتیویتی تعریف می‌کنم:

private String mPackageName = "org.videolan.vlc";

تا اینجای کار اکتیویتی به صورت زیر تکمیل شده است:

MainActivity.java

package ir.android_studio.appinstalled;

import androidx.appcompat.app.AppCompatActivity;

import android.content.Context;
import android.content.Intent;
import android.content.pm.ActivityInfo;
import android.content.pm.PackageManager;
import android.content.pm.ResolveInfo;
import android.os.Bundle;
import android.widget.Toast;

import java.util.ArrayList;
import java.util.List;

public class MainActivity extends AppCompatActivity {

    private String mPackageName = "org.videolan.vlc";

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        // installedOrNot(getApplicationContext(), "com.farsitel.bazaar");
        appStatus();

    }

    /* private boolean installedOrNot(Context cnt, String packageName) {

        PackageManager pm = cnt.getPackageManager();
        boolean appInstalled;

        try {
            pm.getPackageInfo(packageName, PackageManager.GET_ACTIVITIES);
            appInstalled = true;
            Toast.makeText(cnt, "برنامه قبلا نصب شده است", Toast.LENGTH_LONG).show();
        } catch (PackageManager.NameNotFoundException e) {
            appInstalled = false;
            Toast.makeText(cnt, " برنامه قبلا نصب نشده است", Toast.LENGTH_LONG).show();
        }
        return appInstalled;

    } */


    protected List<String> getInstalledAppsPackage() {

        Intent mIntent = new Intent(Intent.ACTION_MAIN, null);
        mIntent.addCategory(Intent.CATEGORY_LAUNCHER);
        mIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK|Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
        List<ResolveInfo> resolveInfoList = getPackageManager().queryIntentActivities(mIntent, 0);
        List<String> packageNameList = new ArrayList<>();

        for (ResolveInfo resolveInfo: resolveInfoList) {
            ActivityInfo actInfo = resolveInfo.activityInfo;
            packageNameList.add(actInfo.applicationInfo.packageName);
        }

        return packageNameList;

    }

    private void appStatus() {

        final List<String> installedPackages = getInstalledAppsPackage();

        if (installedPackages.contains(mPackageName)) {
            Toast.makeText(this, "برنامه قبلا نصب شده است", Toast.LENGTH_LONG).show();
        } else {
            Toast.makeText(this, "برنامه قبلا نصب نشده است", Toast.LENGTH_LONG).show();
        }

    }

}

با اجرای مجدد پروژه، پیغام عدم نصب نمایش داده خواهد شد زیرا این پلیر روی دستگاه نصب نیست.
در قسمت بعد نحوه هدایت کاربر به صفحه نصب یا دریافت برنامه را بررسی می‌کنیم.

هدایت کاربر به صفحه نصب برنامه در مارکت یا یک صفحه وب

چنانچه قصد داشته باشیم برای راحتی کاربر، در صورت نصب نبودن برنامه مورد نیاز به سرعت او را به صفحه دریافت و نصب برنامه هدایت کنیم، با استفاده از یک دستور try catch این کار را انجام می‌دهیم. قصد دارم برای روش دوم که مربوط به برنامه VLC بود، کدی را بنویسم که در صورت نصب نبودن آن، ابتدا صفحه مربوط به آن در مارکت اندرویدی پیش فرض روی دستگاه باز شده و چنانچه مارکتی وجود نداشت، کاربر به یک آدرس اینترنتی هدایت شود.
یک متد دیگر با نام installApp به اکتیویتی اضافه کرده و به صورت زیر تکمیل می‌کنم:

private void installApp() {

    try {
        startActivity(new Intent(Intent.ACTION_VIEW, Uri.parse("market://details?id=" + mPackageName)));
    } catch (android.content.ActivityNotFoundException ane) {
        startActivity(new Intent(Intent.ACTION_VIEW, Uri.parse("https://play.google.com/store/apps/details?id=" + mPackageName)));
    }

}

برای انتقال کاربر به صفحه معرفی یک برنامه در مارکت‌های اندرویدی، uri به صورت

market://details?id=PACKAGE_NAME

تعریف می‌شود. برای قسمت دوم شرط هم من صفحه معرفی برنامه در پلی استور را قرار دادم. نحوه تعیین آدرس صفحه برنامه‌ها در پلی استور به اینصورت است:

https://play.google.com/store/apps/details?id=PACKAGE_NAME

حالا متد را در قسمت دوم شرط مربوط به appStatus فراخوانی می‌کنم:

if (installedPackages.contains(mPackageName)) {
    Toast.makeText(this, "برنامه قبلا نصب شده است", Toast.LENGTH_LONG).show();
} else {
    Toast.makeText(this, "برنامه قبلا نصب نشده است", Toast.LENGTH_LONG).show();
    installApp();
}

دوباره پروژه را اجرا می‌کنم. با توجه به نصب نبودن پلیر VLC روی این دیوایس، صفحه نصب آن در مارکت بازار باز شد:

فروشگاه پلی استور به صورت پیش فرض روی دیوایس‌های شبیه ساز اندرویدی Genymotion نصب نیست و با توجه به اینکه در قسمت نخست آموزش، برنامه کافه بازار را نصب کرده بودیم، در اینجا صفحه نصب پلیر VLC در این مارکت باز شد.
در قدم نهایی، مارکت کافه بازار را حذف و پروژه را مجدد اجرا می‌کنم:

مشاهده می‌کنید صفحه معرفی و نصب برنامه در play.google.com در مرورگر دستگاه باز شد.
کد نهایی اکتیویتی:

MainActivity.java

package ir.android_studio.appinstalled;

import androidx.appcompat.app.AppCompatActivity;

import android.content.Context;
import android.content.Intent;
import android.content.pm.ActivityInfo;
import android.content.pm.PackageManager;
import android.content.pm.ResolveInfo;
import android.net.Uri;
import android.os.Bundle;
import android.widget.Toast;

import java.util.ArrayList;
import java.util.List;

public class MainActivity extends AppCompatActivity {

    private String mPackageName = "org.videolan.vlc";

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        // installedOrNot(getApplicationContext(), "com.farsitel.bazaar");
        appStatus();

    }

    /* private boolean installedOrNot(Context cnt, String packageName) {

        PackageManager pm = cnt.getPackageManager();
        boolean appInstalled;

        try {
            pm.getPackageInfo(packageName, PackageManager.GET_ACTIVITIES);
            appInstalled = true;
            Toast.makeText(cnt, " برنامه قبلا نصب نشده است", Toast.LENGTH_LONG).show();
        } catch (PackageManager.NameNotFoundException e) {
            appInstalled = false;
            Toast.makeText(cnt, "برنامه قبلا نصب نشده است", Toast.LENGTH_LONG).show();
        }
        return appInstalled;

    } */

    protected List<String> getInstalledAppsPackage() {

        Intent mIntent = new Intent(Intent.ACTION_MAIN, null);
        mIntent.addCategory(Intent.CATEGORY_LAUNCHER);
        mIntent.setFlags(Intent.FLAG_ACTIVITY_NEW_TASK|Intent.FLAG_ACTIVITY_RESET_TASK_IF_NEEDED);
        List<ResolveInfo> resolveInfoList = getPackageManager().queryIntentActivities(mIntent, 0);
        List<String> packageNameList = new ArrayList<>();

        for (ResolveInfo resolveInfo: resolveInfoList) {
            ActivityInfo actInfo = resolveInfo.activityInfo;
            packageNameList.add(actInfo.applicationInfo.packageName);
        }

        return packageNameList;

    }

    private void appStatus() {

        final List<String> installedPackages = getInstalledAppsPackage();

        if (installedPackages.contains(mPackageName)) {
            Toast.makeText(this, "برنامه قبلا نصب شده است", Toast.LENGTH_LONG).show();
        } else {
            Toast.makeText(this, "برنامه قبلا نصب نشده است", Toast.LENGTH_LONG).show();
            installApp();
        }

    }

    private void installApp() {

        try {
            startActivity(new Intent(Intent.ACTION_VIEW, Uri.parse("market://details?id=" + mPackageName)));
        } catch (android.content.ActivityNotFoundException ane) {
            startActivity(new Intent(Intent.ACTION_VIEW, Uri.parse("https://play.google.com/store/apps/details?id=" + mPackageName)));
        }

    }

}

موفق و پیروز باشید.

مطالعه‌ی بیشتر:

https://developer.android.com/reference/android/content/pm/ResolveInfo
https://developer.android.com/reference/android/content/pm/PackageManager
https://developer.android.com/reference/android/content/Intent

توجه : سورس پروژه درون پوشه Exercises قرار دارد

نوشته بررسی نصب بودن برنامه در اندروید اولین بار در اندروید استودیو پدیدار شد.

چرخش صفحه نمایش (اکتیویتی) برنامه اندرویدی

به نام خدا. حتما در کار با برنامه‌های موبایلی و بخصوص اندرویدی، با قابلیت چرخش صفحه نمایش هنگام چرخش و تغییر وضعیت دستگاه مواجه شده‌اید. هنگام چرخش موبایل یا تبلت توسط کاربر، وضعیت جدید دستگاه توسط سنسور تعبیه شده در آن تشخیص داده شده و سیستم عامل نیز وضعیت جهت صفحه نمایش و به عبارت دیگر، اکتیویتی در حال اجرای برنامه را بر اساس جهت قرار گیری دستگاه تغییر می‌دهد.

به طور خلاصه، هنگامی که دستگاه در حالت افقی یا Landscape قرار گرفته باشد، اکتیویتی نیز به حالت افقی نمایش داده می‌شود. و همچنین هنگامی که دستگاه در حالت عمودی یا Portrait قرار گرفته باشد، اکتیویتی نیز به حالت عمودی نمایش داده می‌شود.

غیر فعال کردن چرخش صفحه نمایش

اما گاهی اوقات لازم است این قابلیت در برنامه و یا برخی از اکتیویتی‌های آن غیر فعال شده و اکتیویتی صرفا در یک حالت ثابت نمایش داده شود. از نمونه‌های بارز آن می‌توان به بازی‌های موبایلی اشاره کرد که غالباً در یک جهت ثابت تعریف شده‌اند و با چرخش دستگاه، جهت صفحه تغییر نمی‌کند.
بجز بازی‌ها در برخی دیگر از برنامه‌ها نیز بنا به ماهیت برنامه و محتویات آن ممکن است بخواهیم وضعیت اکتیویتی را در یک حالت مشخص قفل کنیم. برای مثال به اپلیکیشن‌های بانکی اشاره می‌کنم که عمدتا در حالت عمودی طراحی شده و با چرخش موبایل یا تبلت همچنان در حالت عمودی قرار دارند.
در مبحث آموزش تشخیص جهت صفحه نمایش دستگاه اندرویدی نحوه بررسی وضعیت فعلی صفحه نمایش پرداختیم. در این جلسه به نحوه غیر فعال کردن چرخش صفحه نمایش در اندروید و همچنین انواع روش‌ها و جزئیات آنها می‌پردازم.

پروژه مدیریت و غیر فعال کردن چرخش صفحه نمایش (اکتیویتی) در اندروید

می‌خواهیم مدیریت و همچنین غیر فعال کردن چرخش صفحه نمایش در اندروید را در قالب یک پروژه ساده بررسی کنیم.
طبق مبحث آموزش ساخت پروژه در اندروید استودیو یک پروژه اندرویدی با نام Manage Orientation می‌سازم. اکتیویتی را از نوع Empty Activity و زبان را Java انتخاب کردم.
برای غیر فعال کردن چرخش صفحه نمایش دو راه وجود دارد. در روش نخست در مانیفست پروژه یک ویژگی (attribute) به تگ اکتیویتی مربوطه اضافه می‌شود اما در روش دوم اینکار مستقیما درون اکتیویتی و در متد onCreate آن انجام می‌شود.
قبل از هر چیز پروژه را اجرا می‌کنم:

به طور پیش فرض، دیوایس در حالت عمودی قرار گرفته که صفحه نمایش و اکتیویتی نیز در همین وضعیت قرار دارد. حالا دستگاه را در وضعیت افقی قرار می‌دهم:

ملاحظه می‌کنید اکتیویتی نیز مطابق با وضعیت دستگاه در حالت افقی قرار گرفته و یک چرخش ۹۰ درجه‌ای انجام شده است.
در ادامه مبحث با استفاده از دو روش، این چرخش را مدیریت و غیر فعال می‌کنیم.

روش اول: غیر فعال کردن چرخش اکتیویتی در مانیفست پروژه

در این روش صرفا با اضافه کردن ویژگی android:screenOrientation به تگ اکتیویتی مدنظر در فایل AndroidManifest.xml تعیین می‌کنیم وضعیت نمایش اکتیویتی روی چه حالتی باید ثابت شود؛ افقی یا عمودی. به کد زیر دقت کنید:

<activity android:name=".MainActivity"
    android:screenOrientation="portrait">
    <intent-filter>
        <action android:name="android.intent.action.MAIN" />

        <category android:name="android.intent.category.LAUNCHER" />
    </intent-filter>
</activity>

برای اکتیویتی MainActivity ویژگی android:screenOrientation با مقدار portrait تعریف کردم. انتظار دارم با اجرای مجدد پروژه، اکتیویتی در حالت افقی دستگاه نیز به صورت portrait نمایش داده شود که با اجرای پروژه، نتیجه مطلوب گرفته می‌شود:

طبیعتا انتظار داریم با تعریف مقدار landscape بجای portrait، اکتیویتی در هر دو حالت قرار گیری دستگاه به صورت افقی نمایش داده شود:

اما هنوز محدودیتی داریم به اینصورت که ثابت شدن وضعیت قرارگیری اکتیویتی فقط در جهت پیش فرض دیوایس انجام می‌شود. یعنی چنانچه مقدار landscape تعریف شود، اکتیویتی فقط در یک جهت افقی دستگاه ثابت می‌ماند و چنانچه کاربر دستگاه را ۱۸۰ درجه بچرخاند به طوری که دستگاه مجدد در حالت افقی قرار گیرد، اکتیویتی به صورت وارونه نمایش داده خواهد شد.
برای حل این مشکل لازم است بجای مقادیر portrait و landscape به ترتیب از sensorPortrait و sensorLandscape استفاده شود. به عبارتی پیشوند sensor به ابتدای مقادیر اضافه شده است. تفاوت این دو گزینه در تصویر زیر مشهود است:

آیتم دیگری نیز وجود دارد که حالت افقی یا عمودی صفحه را می‌توان در جهت عکس حالت پیش فرض افقی یا عمودی دستگاه قرار داد. به عبارتی، صفحه را در وضعیت ۱۸۰ درجه‌ای نسبت به حالت افقی یا عمودی پیش فرض دستگاه قرار می‌دهد. برای اینکار از پیشوند reverse (به معنی معکوس) استفاده می‌کنیم؛ reversePortrait و reverseLandscape. البته بعید می‌دانم این گزینه کاربرد زیادی داشته باشد!
گزینه‌ دیگری که سیستم عامل اندروید در اختیار توسعه دهندگان قرار داده، آیتم‌های userPortrait و userLandscape هستند که از نام آن مشخص است نحوه قرار گیری حالت افقی یا عمودی را بر اساس تنظیماتی که کاربر روی دستگاه خود انجام داده تنظیم می‌شود. یعنی اینکه حالت افقی صفحه در جهت حالت افقی دستگاه باشد یا جهت عکس آن (چرخش ۱۸۰ درجه‌ای) به سلیقه کاربر بستگی خواهد داشت.

روش دوم: غیر فعال کردن چرخش اکتیویتی توسط کد جاوا

در روش دوم، تعیین نحوه چرخش اکتیویتی به طور مستقیم درون خود اکتیویتی و متد onCreate آن انجام می‌شود. برای اینکار از متد setRequestedOrientation استفاده می‌کنیم:

setRequestedOrientation(ActivityInfo.SCREEN_ORIENTATION_SENSOR_LANDSCAPE);

در کد فوق حالت SCREEN_ORIENTATION_SENSOR_LANDSCAPE تعیین شده که با حالت sensorLandscape تعریف شده در تگ اکتیویتی در مانیفست برابر است. سایر آیتم‌ها نیز مشابه آنچه قبلا توضیح دادیم در دسترس هستند:

MainActivity.java

package ir.android_studio.manageorientation;

import androidx.appcompat.app.AppCompatActivity;

import android.content.pm.ActivityInfo;
import android.os.Bundle;

public class MainActivity extends AppCompatActivity {

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        setRequestedOrientation(ActivityInfo.SCREEN_ORIENTATION_SENSOR_LANDSCAPE);

    }
}

موفق و پیروز باشید.

مطالعه‌ی بیشتر:

https://developer.android.com/guide/topics/manifest/activity-element

توجه : سورس پروژه درون پوشه Exercises قرار دارد

نوشته مدیریت و غیر فعال کردن چرخش صفحه نمایش اولین بار در اندروید استودیو پدیدار شد.

مدیریت کیبورد اندروید

به نام خدا. اگر برنامه نویس و توسعه دهنده موبایل و بخصوص اندروید هستید به احتمال زیاد با چالش نمایش کیبورد هنگام عدم نیاز به آن، روبرو شده‌اید. یا اینکه بخشی از برنامه شما باید به صورتی پیاده سازی شود که یک یا چند عملیات بر اساس وضعیت کیبورد، یعنی مخفی یا نمایان بودن آن انجام شود.

در این آموزش ابتدا نحوه حذف کیبورد توسط کلاس InputMethodManager را بررسی کرده و در قسمت بعد، با استفاده از کتابخانه KeyboardVisibilityEvent علاوه بر امکان حذف و نمایش کیبورد، یک شنونده (Listener) نیز برای شنود رویداد حذف و ظاهر شدن کیبورد تعریف می‌کنیم.
طبق مبحث آموزش ساخت پروژه در اندروید استودیو یک پروژه اندرویدی با نام KeyboardManagement می‌سازم. اکتیویتی را از نوع Empty Activity و زبان را Java انتخاب کردم.

حذف و نمایش کیبورد اندروید توسط کلاس InputMethodManager

برای مثال یک فرم عضویت را درنظر بگیرید. طبیعتا بعد از اینکه کاربر اطلاعات لازم را وارد کرده و روی دکمه ثبت نام ضربه بزند، نیازی به باز ماندن کیبورد نیست و عدم مخفی شدن آن، برای کاربر ایجاد مزاحمت کرده که از لحاظ تجربه کاربری (UX) یک آیتم منفی محسوب می‌گردد. بنابراین باید کاری کنیم تا به محض کلیک کردن کاربر روی Button ثبت نام، کیبورد مخفی شود.
در layout اکتیویتی سه ویجت از نوع TextView، EditText و Button تعریف می‌کنم:

activity_main.xml

<?xml version="1.0" encoding="utf-8"?>
<LinearLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:orientation="vertical"
    tools:context=".MainActivity">

    <TextView
        android:id="@+id/txt_result"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_gravity="center_horizontal"
        android:text="متن پیش فرض"
        android:textSize="22sp" />

    <EditText
        android:id="@+id/txt_input"
        android:layout_width="match_parent"
        android:layout_height="wrap_content" />

    <Button
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_gravity="center_horizontal"
        android:id="@+id/submit_btn"
        android:text="ثبت" />

</LinearLayout>

در مرحله بعد یک Listener برای دکمه تعریف می‌کنم به صورتی که متن وارد شده در EditText را روی TextView ست می‌کند:

MainActivity.java

package ir.android_studio.keyboardmanagement;

import androidx.appcompat.app.AppCompatActivity;
import android.os.Bundle;
import android.view.View;
import android.widget.Button;
import android.widget.EditText;
import android.widget.TextView;

public class MainActivity extends AppCompatActivity {

    TextView txtResult;
    EditText txtInput;
    Button btnSubmit;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        txtResult = findViewById(R.id.txt_result);
        txtInput = findViewById(R.id.txt_input);
        btnSubmit = findViewById(R.id.submit_btn);

        btnSubmit.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View view) {

                String userText = txtInput.getText().toString();
                txtResult.setText(userText);

            }
        });

    }
}

پروژه را اجرا کرده و یک متن آزمایشی ثبت می‌کنم:

ملاحظه می‌کنید بعد از پایان کار همچنان کیبورد نمایش داده می‌شود.
برای مخفی کردن کیبورد یک متد با نام دلخواه closeKeyboard به اکتیویتی و بعد از متد onCreate اضافه می‌کنم:

private void closeKeyboard() {

    View focusView = this.getCurrentFocus();
    if (focusView != null) {
        InputMethodManager imm = (InputMethodManager) getSystemService(Context.INPUT_METHOD_SERVICE);
        imm.hideSoftInputFromWindow(focusView.getWindowToken(), 0);
    }

}

در خط نخست، view ای که روی آن focus (تمرکز) شده را در یک متغیر از جنس View ذخیره می‌کنم. من نام این متغیر را focusView انتخاب کردم. بنابراین در پروژه فعلی ما، هنگامی که کاربر روی EditText کلیک می‌کند، این view ذخیره می‌شود. در ادامه یک شرط تعریف شده که ابتدا بررسی می‌کند focusView برابر با null نباشد. یعنی چنانچه هیچ view ای در حالت focus قرار نگرفته باشد، کدهای درون این شرط اجرا نخواهد شد.
درون این شرط یک نمونه از کلاس InputMethodManager با نام imm ساخته‌ام. در خط آخر، توسط متد hideSoftInputFromWindow این کلاس، SoftInput یا به عبارتی همان کیبورد (ورودی نرم افزاری) مخفی (hide) می‌شود.
در نهایت، متد را در Listener دکمه فراخوانی می‌کنم:

btnSubmit.setOnClickListener(new View.OnClickListener() {
    @Override
    public void onClick(View view) {

        String userText = txtInput.getText().toString();
        txtResult.setText(userText);
        closeKeyboard();

    }
});

کد کامل اکتیویتی:

MainActivity.java

package ir.android_studio.keyboardmanagement;

import androidx.appcompat.app.AppCompatActivity;

import android.content.Context;
import android.os.Bundle;
import android.view.View;
import android.view.inputmethod.InputMethodManager;
import android.widget.Button;
import android.widget.EditText;
import android.widget.TextView;

public class MainActivity extends AppCompatActivity {

    TextView txtResult;
    EditText txtInput;
    Button btnSubmit;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        txtResult = findViewById(R.id.txt_result);
        txtInput = findViewById(R.id.txt_input);
        btnSubmit = findViewById(R.id.submit_btn);

        btnSubmit.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View view) {

                String userText = txtInput.getText().toString();
                txtResult.setText(userText);
                closeKeyboard();

            }
        });

    }

    private void closeKeyboard() {

        View focusView = this.getCurrentFocus();
        if (focusView != null) {
            InputMethodManager imm = (InputMethodManager) getSystemService(Context.INPUT_METHOD_SERVICE);
            imm.hideSoftInputFromWindow(focusView.getWindowToken(), 0);
        }

    }

}

پروژه را دوباره اجرا می‌کنم:

حالا بلافاصله بعد از کلیک روی دکمه ثبت، کیبوردی که به واسطه focus شدن روی EditText باز شده بود، مخفی شد.

مدیریت کیبورد اندروید توسط کتابخانه KeyboardVisibilityEvent

در قسمت قبل بدون استفاده از کتابخانه و صرفا توسط کلاس داخلی اندروید، کیبورد را مخفی کردیم. اما در این قسمت برای مدیریت کیبورد نرم افزاری اندروید از کتابخانه KeyboardVisibilityEvent استفاده می‌کنیم که علاوه بر امکان نمایش دادن یا مخفی کردن کیبورد، به رویداد باز یا بسته شدن کیبورد هم می‌توانیم گوش دهیم. یعنی این کتابخانه مخفی و ظاهر شدن کیبورد را گزارش می‌دهد که در برخی موارد ممکن است توسعه دهنده به آن نیاز داشته باشد.
آدرس معرفی کتابخانه در گیت هاب:

https://github.com/yshrsmz/KeyboardVisibilityEvent

طبق توضیحات صفحه گیت هاب کتابخانه برای افزودن آن به پروژه باید خط زیر را در build.gradle اضافه کنم:

implementation 'net.yslibrary.keyboardvisibilityevent:keyboardvisibilityevent:LATEST_VERSION'

implementation 'net.yslibrary.keyboardvisibilityevent:keyboardvisibilityevent:3.0.0-RC2'

پروژه را سینک می‌کنم تا کتابخانه اضافه شود.

مخفی کردن و نمایش کیبورد

برای مخفی کردن کیبورد کافیست خط زیر را در متد Listener دکمه بجای متد closeKeyboard اضافه کنم:

UIUtil.hideKeyboard(MainActivity.this);

UIUtil یکی از کلاس‌های کتابخانه است. متد hideKeyboard این کتابخانه، کیبورد را مخفی می‌کند. علاوه بر این، متد showKeyboard عمل خلاف متد قبل، یعنی نمایش کیبورد را انجام می‌دهد. البته در حالت عادی، با focus شدن کاربر روی یک EditText کیبورد به طور خودکار نمایش داده می‌شود اما ممکن است استثنائاتی وجود داشته باشد که لازم باشد اندروید را وادار به نمایش کیبورد کنیم. این متد بر خلاف متد hideKeyboard که فقط یک پارامتر ورودی دارد، پارامتر دوم هم باید وارد شود که نام EditText مدنظر ماست. این متد را به onCreate اکتیویتی اضافه کردم:

UIUtil.showKeyboard(MainActivity.this, txtInput);

گوش دادن به رویداد حذف یا ظاهر شدن کیبورد

با استفاده از متد setEventListener کلاس KeyboardVisibilityEvent این کتابخانه، به صورت زیر یک متد با نام onVisibilityChanged ساخته می‌شود:

KeyboardVisibilityEvent.setEventListener(this, new KeyboardVisibilityEventListener() {
    @Override
    public void onVisibilityChanged(boolean b) {

    }
});

تغییر وضعیت کیبورد از طریق پارامتر b دریافت می‌شود. برای نمایش خروجی این متد، یک شرط تعریف می‌کنم که خروجی هر حالت در قالب یک Toast ظاهر می‌شود:
KeyboardVisibilityEvent.setEventListener(this, new KeyboardVisibilityEventListener() {
    @Override
    public void onVisibilityChanged(boolean b) {

        if (b) {
            Toast.makeText(MainActivity.this, "کیبورد ظاهر شد", Toast.LENGTH_SHORT).show();
        } else {
            Toast.makeText(MainActivity.this, "کیبورد حذف شد", Toast.LENGTH_SHORT).show();
        }

    }
});

کد کامل اکتیویتی:

MainActivity.java

package ir.android_studio.keyboardmanagement;

import androidx.appcompat.app.AppCompatActivity;

import android.content.Context;
import android.os.Bundle;
import android.view.View;
import android.view.inputmethod.InputMethodManager;
import android.widget.Button;
import android.widget.EditText;
import android.widget.TextView;
import android.widget.Toast;

import net.yslibrary.android.keyboardvisibilityevent.KeyboardVisibilityEvent;
import net.yslibrary.android.keyboardvisibilityevent.KeyboardVisibilityEventListener;
import net.yslibrary.android.keyboardvisibilityevent.util.UIUtil;

public class MainActivity extends AppCompatActivity {

    TextView txtResult;
    EditText txtInput;
    Button btnSubmit;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        txtResult = findViewById(R.id.txt_result);
        txtInput = findViewById(R.id.txt_input);
        btnSubmit = findViewById(R.id.submit_btn);

        UIUtil.showKeyboard(MainActivity.this, txtInput);

        btnSubmit.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View view) {

                String userText = txtInput.getText().toString();
                txtResult.setText(userText);
                //closeKeyboard();
                UIUtil.hideKeyboard(MainActivity.this);

            }
        });

        KeyboardVisibilityEvent.setEventListener(this, new KeyboardVisibilityEventListener() {
            @Override
            public void onVisibilityChanged(boolean b) {

                if (b) {
                    Toast.makeText(MainActivity.this, "کیبورد ظاهر شد", Toast.LENGTH_SHORT).show();
                } else {
                    Toast.makeText(MainActivity.this, "کیبورد حذف شد", Toast.LENGTH_SHORT).show();
                }

            }
        });

    }

    private void closeKeyboard() {

        View focusView = this.getCurrentFocus();
        if (focusView != null) {
            InputMethodManager imm = (InputMethodManager) getSystemService(Context.INPUT_METHOD_SERVICE);
            imm.hideSoftInputFromWindow(focusView.getWindowToken(), 0);
            imm.showSoftInput(focusView, 0);
        }

    }

}

پروژه را اجرا می‌کنم:

مشاهده می‌کنید پیغام‌های “کیبورد ظاهر شد” و “کیبورد حذف شد” در زمان مناسب نمایش داده شده است.
موفق و پیروز باشید.

مطالعه‌ی بیشتر:

https://developer.android.com/reference/android/content/Context#INPUT_METHOD_SERVICE
https://developer.android.com/reference/android/app/Activity#getCurrentFocus()

توجه : سورس پروژه درون پوشه Exercises قرار دارد

نوشته حذف، نمایش و مدیریت کیبورد اندروید اولین بار در اندروید استودیو پدیدار شد.

بدست آوردن اطلاعات دستگاه‌های اندرویدی

به نام خدا. با توجه به متن باز بودن سیستم عامل اندروید، تولید کنندگان مطرح و گمنام بی شماری انواع دستگاه‌های اندرویدی را تولید و روانه بازار می‌کنند. هر مدل از این دیوایس‌ها دارای سخت افزاری متفاوت از سایر مدل‌هاست. همچنین با توجه به انتشار نسخه‌های جدید اندروید توسط گوگل، نسخه‌های مختلفی از این سیستم عامل توسط کاربران در حال استفاده است.
گاهی اوقات ممکن است بخشی از عملکرد برنامه ما وابسته به نسخه خاصی از اندروید و یا سخت افزار مانند CPU باشد. یا اینکه بخواهیم بخشی از برنامه بر اساس تفاوت سخت افزار و نرم افزار هر دستگاه، به شیوه متفاوتی اجرا شود. در هر صورت لازم است تا توسعه دهنده اندروید به ویژگی‌های نرم افزاری و سخت افزاری دستگاه دسترسی داشته باشد.
در اندروید کلاسی با نام Build این وظیفه را بعهده دارد. در آموزش‌های گذشته مانند آموزش کار با نوتیفیکیشن در اندروید و آموزش Service در اندروید نیز از این کلاس برای تشخیص نسخه اندروید و انجام عمل متناسب با آن استفاده کرده بودیم. در این جلسه قصد دارم سایر قابلیت‌های این کلاس را بررسی کنم.

ویژگی‌های کلاس Build

در جدول زیر به تعدادی از ویژگی‌های کلاس Build پرداخته و کاربرد هرکدام را به مختصر توضیح می‌دهم:

پروژه بدست آوردن اطلاعات دستگاه اندرویدی

قصد دارم تعدادی از مهمترین ویژگی‌های کلاس Build اندروید را در قالب یک پروژه ساده استفاده کنم بطوری که خروجی روی اکتیویتی نمایش داده شود. مطابق مبحث آموزش ساخت پروژه در اندروید استودیو یک پروژه اندرویدی با نام DeviceInfo می‌سازم. اکتیویتی را از نوع Empty Activity و زبان را Java انتخاب کردم.
ابتدا ۵ عدد TextView به layout اکتیویتی اضافه می‌کنم. هرکدام از این View ها یکی از مشخصات دستگاه را نمایش خواهد داد.

activity_main.xml

<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout 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"
    android:gravity="center"
    tools:context=".MainActivity">

    <TextView
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:id="@+id/txt_manufacturer"
        android:textSize="20dp"
        android:text="" />

    <TextView
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:id="@+id/txt_model"
        android:textSize="20dp"
        android:text=""
        android:layout_below="@id/txt_manufacturer" />

    <TextView
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:id="@+id/txt_version"
        android:textSize="20dp"
        android:text=""
        android:layout_below="@id/txt_model"/>

    <TextView
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:id="@+id/txt_sdk"
        android:textSize="20dp"
        android:text=""
        android:layout_below="@id/txt_version" />

    <TextView
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:id="@+id/txt_hardware"
        android:textSize="20dp"
        android:text=""
        android:layout_below="@id/txt_sdk" />

</RelativeLayout>

سپس اکتیویتی را به صورت زیر تکمیل می‌کنم:

MainActivity.java

package ir.android_studio.deviceinfo;

import androidx.appcompat.app.AppCompatActivity;

import android.os.Build;
import android.os.Bundle;
import android.widget.TextView;
import android.widget.Toast;

public class MainActivity extends AppCompatActivity {

    TextView manufacturerTxt, modelTxt, versionTxt, sdkTxt, hardwareTxt;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        manufacturerTxt = findViewById(R.id.txt_manufacturer);
        modelTxt = findViewById(R.id.txt_model);
        versionTxt = findViewById(R.id.txt_version);
        sdkTxt = findViewById(R.id.txt_sdk);
        hardwareTxt = findViewById(R.id.txt_hardware);

        String manufacturer = Build.MANUFACTURER;
        String model = Build.MODEL;
        String version = Build.VERSION.RELEASE;
        int sdk = Build.VERSION.SDK_INT;
        String hardware = Build.HARDWARE;

        manufacturerTxt.setText("Manufacturer: " + manufacturer);
        modelTxt.setText("Model: " + model);
        versionTxt.setText("Version: " + version);
        sdkTxt.setText("SDK: " + Integer.toString(sdk));
        hardwareTxt.setText("Hardware: " + hardware);

    }
}

چهار متغیر از جنس String و یک متغیر از جنس int تعریف کرده‌ام که به ترتیب، مشخصات مربوط به MANUFACTURER و MODEL و RELEASE و SDK_INT و HARDWARE را از کلاس Build گرفته و ذخیره می‌کنند. در نهایت هرکدام را روی یک TextView نمایش می‌دهم.
پروژه را اجرا می‌کنم:

ملاحظه می‌کنید مشخصات دستگاه شامل نام سازنده، مدل دستگاه، نسخه اندروید، نسخه SDK و مدل CPU در اکتیویتی نمایش داده شده است.
از جمله کارایی‌های این کلاس می‌توان به اجرا یا عدم اجرای کد ساخت کانال نوتیفیکیشن بر اساس نسخه سیستم عامل اشاره کرد که در مبحث آموزش کار با نوتیفیکیشن در اندروید به آن پرداخته شده است:

if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {

    // Create Notification channel

}

شرط فوق بررسی می‌کند در صورتی کد اجرا شود که نسخه اندروید دستگاه حداقل Oreo و یا بالاتر باشد.
موفق و پیروز باشید.

مطالعه‌ی بیشتر:

https://developer.android.com/reference/android/os/Build
https://developer.android.com/reference/android/os/Build.VERSION

توجه : سورس پروژه درون پوشه Exercises قرار دارد

نوشته بدست آوردن اطلاعات دستگاه اندرویدی اولین بار در اندروید استودیو پدیدار شد.

تشخیص جهت صفحه نمایش در اندروید

به نام خدا. در روند توسعه یک اپلیکیشن اندرویدی ممکن است در برخی مواقع لازم باشد عمل یا اعمالی بر اساس نحوه قرارگیری دستگاه انجام شوند. این عمل و تغییرات می‌تواند در رابط کاربری بوده و یا اینکه مربوط به عملکرد اصلی برنامه ما باشد.
برای تشخیص جهت قرارگیری صفحه نمایش به دو روش می‌توان عمل کرد که در ادامه و در قالب یک پروژه، هر دو روش را بررسی می‌کنیم. مطابق مبحث آموزش ساخت پروژه در اندروید استودیو یک پروژه اندرویدی با نام Orientation می‌سازم. اکتیویتی را از نوع Empty Activity و زبان را Java انتخاب کردم.
ابتدا دو TextView در layout اکتیویتی تعریف می‌کنم تا خروجی هر دو روش را نمایش دهد:

activity_main.xml

<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout 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"
    android:gravity="center"
    tools:context=".MainActivity">

    <TextView
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:id="@+id/txt_one"
        android:textSize="30dp"
        android:text="" />

    <TextView
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:id="@+id/txt_two"
        android:textSize="30dp"
        android:text=""
        android:layout_below="@id/txt_one" />

</RelativeLayout>

روش اول تشخیص جهت صفحه نمایش

در این روش با استفاده از کلاس Configuration وضعیت فعلی صفحه نمایش را بررسی کرده و با تعریف یک شرط، خروجی مناسب را دریافت می‌کنیم.

MainActivity.java

package ir.android_studio.orientation;

import androidx.appcompat.app.AppCompatActivity;

import android.content.res.Configuration;
import android.os.Bundle;
import android.widget.TextView;

public class MainActivity extends AppCompatActivity {

    TextView txtOne, txtTwo;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        txtOne = findViewById(R.id.txt_one);
        txtTwo = findViewById(R.id.txt_two);

        int screenOrientation = this.getResources().getConfiguration().orientation;

        if (screenOrientation == Configuration.ORIENTATION_LANDSCAPE) {
            txtOne.setText("Landscape");
        } else {
            txtOne.setText("Portrait");
        }

    }
}

یک متغیر با نام دلخواه screenOrientation و از جنس int تعریف کردم که orientation فعلی صفحه را در خود ذخیره می‌کند:

int screenOrientation = this.getResources().getConfiguration().orientation;

عدد ذخیره شده در متغیر فوق، عدد ۱ یا ۲ خواهد بود که عدد ۱ نشانه وضعیت Portrait و عدد ۲ نشانه وضعیت Landscape است. سپس یک شرط تعریف شده که بررسی می‌کند چنانچه مقدار ذخیره شده در این متغیر با Configuration.ORIENTATION_LANDSCAPE برابر باشد (به عبارتی عدد ۲ ذخیره شده باشد) قسمت اول شرط و در غیر اینصورت قسمت دوم شرط اجرا شود. بدیهی است چنانچه از Configuration.ORIENTATION_PORTRAIT استفاده می‌کردم خروجی شرط بلعکس می‌شد. کانتکست را this قرار داده‌ام.
پروژه را اجرا می‌کنم:

در ابتدای اجرای شبیه ساز Genymotion صفحه نمایش در حالت عمودی قرار دارد و خروجی شرط که در TextView نمایش داده شده با وضعیت دستگاه همخوانی داشته و عبارت Portrait را نمایش می‌دهد. حالا دستگاه را در حالت افقی قرار می‌دهم:

مشاهده می‌کنید با تغییر وضعیت صفحه نمایش و قرار گرفتن در حالت افقی یا Landscape و restart شدن اکتیویتی، قسمت دوم شرط اجرا شده است.

روش دوم تشخیص جهت صفحه نمایش

در این قسمت از resource پروژه برای تشخیص وضعیت صفحه نمایش استفاده می‌کنیم. روی فولدر res پروژه راست کلیک کرده و Android Resource File را انتخاب می‌کنم:

نام فایل را layouts وارد کرده و در قسمت Directory name مطابق تصویر فوق، values-land می‌نویسم. از آنجایی که نام این دایرکتوری به land ختم شده، محتویات داخل آن در صورتی در دسترس خواهد بود که وضعیت صفحه نمایش در حالت Landscape قرار گرفته باشد. پس از ایجاد فایل layouts.xml آنرا به صورت زیر تکمیل می‌کنم:

values-land/layouts.xml

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <bool name="is_landscape">true</bool>
</resources>

در این فایل یک ویژگی از جنس bool (مخفف boolean) تعریف کردم با نام دلخواه is_landscape و مقدار true. مجدد یک فایل دیگر به همین شیوه و با همان نام layouts.xml اما اینبار در دایرکتوری values-port ایجاد می‌کنم:

values-port/layouts.xml

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <bool name="is_landscape">false</bool>
</resources>

در این فایل هم یک ویژگی با نام is_landscape تعریف کردم با این تفاوت که مقدار آن false است. این دو فایل در محیط پروژه به اینصورت نمایش داده می‌شود:

حالا در اکتیویتی یک متغیر از جنس boolean تعریف می‌کنم:

boolean isLandscape = this.getResources().getBoolean(R.bool.is_landscape);

توسط کد فوق، مقدار ویژگی bool با نام is_landscape از layouts.xml ای که با توجه به وضعیت صفحه نمایش در دسترس است، در متغیر isLandscape ذخیره می‌شود. یعنی چنانچه صفحه نمایش در حالت افقی قرار داشته باشد، layouts.xml دایرکتوری values-land در دسترس خواهد بود در نتیجه مقدار true را برمی‌گرداند و همینطور برای حالت عمودی مقدار false. در نهایت شرطی را برای بررسی خروجی این متغیر مانند قسمت قبل تعریف می‌کنم:

if (isLandscape) {
    txtTwo.setText("Landscape");
} else {
    txtTwo.setText("Portrait");
}

مجدد پروژه را اجرا می‌کنم:

ملاحظه می‌کنید خروجی هردو روش بر اساس افقی یا عمودی بودن دستگاه بروز می‌شود.
کد کامل اکتیویتی:

MainActivity.java

package ir.android_studio.orientation;

import androidx.appcompat.app.AppCompatActivity;

import android.content.res.Configuration;
import android.os.Bundle;
import android.widget.TextView;

public class MainActivity extends AppCompatActivity {

    TextView txtOne, txtTwo;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        txtOne = findViewById(R.id.txt_one);
        txtTwo = findViewById(R.id.txt_two);

        int screenOrientation = this.getResources().getConfiguration().orientation;

        if (screenOrientation == Configuration.ORIENTATION_LANDSCAPE) {
            txtOne.setText("Landscape");
        } else {
            txtOne.setText("Portrait");
        }

        boolean isLandscape = this.getResources().getBoolean(R.bool.is_landscape);

        if (isLandscape) {
            txtTwo.setText("Landscape");
        } else {
            txtTwo.setText("Portrait");
        }

    }
}

موفق و پیروز باشید.

مطالعه‌ی بیشتر:

https://developer.android.com/reference/android/content/res/Configuration

توجه : سورس پروژه درون پوشه Exercises قرار دارد

نوشته تشخیص جهت (orientation) صفحه نمایش دستگاه اندرویدی اولین بار در اندروید استودیو پدیدار شد.

بدست آوردن اندازه صفحه نمایش در اندروید

به نام خدا. در برخی موارد ممکن است توسعه دهنده و برنامه نویس اندروید، نیازمند دانستن اندازه (طول و عرض) صفحه نمایش دستگاه‌های اندرویدی بر حسب پیکسل (pixel) باشد تا بر اساس آن بتواند عمل مناسبی انجام دهد. همچنین می‌توان تراکم پیکسلی صفحه نمایش یا همان DPI (مخفف Dots per inch) به معنی تعداد نقطه در اینچ را نیز بدست آورد.
برای اینکار مطابق مبحث آموزش ساخت پروژه در اندروید استودیو یک پروژه اندرویدی با نام ScreenSize می‌سازم. اکتیویتی را از نوع Empty Activity و زبان را Java انتخاب کردم. در این تمرین از دو کلاس Display و DisplayMetrics برای بدست آوردن اندازه صفحه نمایش استفاده می‌کنم که از کلاس دوم علاوه بر سایر صفحه نمایش، DPI صفحه هم بدست می‌آید.
قبل از کار با کلاس‌ها، دو TextView در layout اکتیویتی تعریف می‌کنم:

activity_main.xml

<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout 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"
    android:gravity="center"
    tools:context=".MainActivity">

    <TextView
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:id="@+id/display"
        android:text="" />

    <TextView
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:id="@+id/display_metrics"
        android:text=""
        android:layout_below="@id/display" />

</RelativeLayout>

بدست آوردن اندازه صفحه نمایش توسط کلاس Display

ابتدا یک نمونه از کلاس Display به صورت زیر می‌سازم:

Display displaySize = getWindowManager().getDefaultDisplay();

با تعریف کد فوق، اطلاعات مربوط به صفحه نمایش دستگاه اندرویدی از جمله نام صفحه و اندازه آن در displaySize ذخیره می‌شود. سپس یک نمونه از کلاس Point می‌سازم تا مختصات طول و عرض صفحه نمایش را از displaySize دریافت و ذخیره کند:

Point size = new Point();
displaySize.getSize(size);

توسط getSize() مختصات در size ذخیره شده است. در نهایت، طول و عرض دریافتی را به دو مقدار از جنس int تبدیل می‌کنم:

int displayWidth = size.x;
int displayHeight = size.y;

در دو خط بالا، size.x اندازه عرض و size.y اندازه ارتفاع یا طول را برمی‌گرداند که در دو int ذخیره شده است.
حالا مختصات را در TextView اولی نمایش می‌دهم. کد کامل اکتیویتی:

MainActivity.java

package ir.android_studio.screensize;

import androidx.appcompat.app.AppCompatActivity;

import android.graphics.Point;
import android.os.Bundle;
import android.view.Display;
import android.widget.TextView;

public class MainActivity extends AppCompatActivity {

    TextView txtDisplay, txtDisplayMetrics;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        txtDisplay = findViewById(R.id.display);
        txtDisplayMetrics = findViewById(R.id.display_metrics);

        Display displaySize = getWindowManager().getDefaultDisplay();
        Point size = new Point();
        displaySize.getSize(size);
        int displayWidth = size.x;
        int displayHeight = size.y;

        txtDisplay.setText("Width: " + displayWidth + " / " + "Height: " + displayHeight);

    }
}

پروژه را اجرا می‌کنم:

مشاهده می‌کنید اعداد ۱۰۸۰ و ۲۰۳۴ به ترتیب عرض و ارتفاع صفحه نمایش این دستگاه، یعنی دیوایس مجازی شبیه ساز اندرویدی Genymotion را نشان می‌دهند.

بدست آوردن اندازه صفحه نمایش توسط کلاس DisplayMetrics

کدهای زیر را به اکتیویتی اضافه می‌کنم:

DisplayMetrics metricSize = new DisplayMetrics();
getWindowManager().getDefaultDisplay().getMetrics(metricSize);
int metricDisplayWidth = metricSize.widthPixels;
int metricDisplayHeight = metricSize.heightPixels;
int metricDPI = metricSize.densityDpi;
float xdp = metricSize.xdpi;
float ydp = metricSize.ydpi;
txtDisplayMetrics.setText("Width: " + metricDisplayWidth + " / " + "Height: " + metricDisplayHeight + " DPI: " + metricDPI + " X:" + xdp + " Y:" + ydp);

در این قسمت و با استفاده از کلاس DisplayMetrics مانند قسمت قبل ابتدا اندازه صفحه نمایش بر حسب پیکسل گرفته شده است. metricSize.widthPixels مقدار عرض و metricSize.heightPixels مقدار ارتفاع را برمی‌گرداند. همچنین metricSize.densityDpi مقدار DPI صفحه را برمی‌گرداند. علاوه بر آن، مختصات طول و عرض DPI هم توسط metricSize.xdpi و metricSize.ydpi گرفته شده است.
مجدد پروژه را اجرا می‌کنم:

در تصویر فوق ملاحظه می‌کنید طول و عرض صفحه نمایش مانند خروجی کلاس قبل بوده و علاوه بر آن، DPI صفحه و مختصات X و Y آن نیز عدد ۴۲۰ را نشان می‌دهد.
کد کامل اکتیویتی:

MainActivity.java

package ir.android_studio.screensize;

import androidx.appcompat.app.AppCompatActivity;

import android.graphics.Point;
import android.os.Bundle;
import android.util.DisplayMetrics;
import android.view.Display;
import android.widget.TextView;

public class MainActivity extends AppCompatActivity {

    TextView txtDisplay, txtDisplayMetrics;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        txtDisplay = findViewById(R.id.display);
        txtDisplayMetrics = findViewById(R.id.display_metrics);

        Display displaySize = getWindowManager().getDefaultDisplay();
        Point size = new Point();
        displaySize.getSize(size);
        int displayWidth = size.x;
        int displayHeight = size.y;

        txtDisplay.setText("Width: " + displayWidth + " / " + "Height: " + displayHeight);

        DisplayMetrics metricSize = new DisplayMetrics();
        getWindowManager().getDefaultDisplay().getMetrics(metricSize);
        int metricDisplayWidth = metricSize.widthPixels;
        int metricDisplayHeight = metricSize.heightPixels;
        int metricDPI = metricSize.densityDpi;
        float xdp = metricSize.xdpi;
        float ydp = metricSize.ydpi;

        txtDisplayMetrics.setText("Width: " + metricDisplayWidth + " / " + "Height: " + metricDisplayHeight + " DPI: " + metricDPI + " X:" + xdp + " Y:" + ydp);

    }
}

مطالعه‌ی بیشتر:

https://developer.android.com/reference/android/view/Display
https://developer.android.com/reference/android/graphics/Point
https://developer.android.com/reference/android/util/DisplayMetrics

توجه : سورس پروژه درون پوشه Exercises قرار دارد

نوشته بدست آوردن اندازه صفحه نمایش دستگاه اندرویدی اولین بار در اندروید استودیو پدیدار شد.