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

شبیه ساز یا Emulator چیست؟

به نام خدا. در زمان نگارش این مبحث آموزشی، اندروید ۱۲ به عنوان آخرین نسخه‌ی پایدار این سیستم‌عامل منتشر شده و حدود ۱۲% از کل دیوایس‌های اندرویدی را پوشش می‌دهد. این یعنی هنوز درصد قبل توجهی از موبایل‌ها، تبلت‌ها و دستگاه‌های اندرویدی دیگر از نسخه‌های پایین‌تر استفاده می‌کنند.
بنابراین شما به عنوان یک برنامه نویس و توسعه دهنده‌ی اندروید لازم است پروژه‌ی اندرویدی خود را روی چندین دستگاه اندرویدی با نسخه‌های متفاوت تست کنید تا مطمئن شوید اپلیکیشن روی اکثر دستگاه‌هایی که در اختیار مردم قرار دارد عملکرد صحیحی خواهد داشت.
به عبارت دیگر شما باید چندین گوشی و تبلت خریداری کنید تا بتوانید پروژه را روی تک تک آنها بررسی کنید که علاوه بر افزایش هزینه، چالش‌های خاص خود را به همراه دارد.
اینجاست که امولاتور یا شبیه سازها وارد میدان شده و کار را بسیار ساده‌تر می‌کنند. با استفاده از شبیه ساز می‌توان هر تعداد از دیوایس‌های مجازی اندرویدی را روی کامپیوتر نصب و اجرا کرد. یعنی دیگر خبری از دیوایس فیزیکی و مشکلات اتصال آن به اندروید استودیو نیست.
با استفاده از امولاتور به راحتی می‌توانید چندین دیوایس مجازی با نسخه‌ی سیستم عامل و اندازه‌ی صفحه نمایش مختلف ایجاد و پروژه‌ی خود را روی آنها تست و دیباگ کنید.
شبیه سازهای مختلفی برای اندروید ساخته شده که روی سیستم‌عامل‌های محبوب مانند ویندوز، لینوکس و مک قابل استفاده هستند. درحال حاضر Genymotion، BlueStacks و MEMu جزء گزینه‌های مطرح به شمار می‌روند.

چرا AVD؟

در اندروید استودیو از همان ابتدای کار یک امولاتور داخلی در اختیار توسعه‌دهندگان قرار گرفته بود که امکان مدیریت دیوایس‌ها با استفاده از ابزار AVD فراهم شده است.
بااینحال از سال ۱۳۹۵ تا اوایل ۱۴۰۱ با توجه به مزایایی که Genymotion نسبت به AVD داشت (مانند سرعت بالاتر و حجم کم دیوایس‌ها) شخصاً ترجیح می‌دادم از جنی موشن استفاده کنم.
اما در ماه‌های اخیر سیاست جنی موشن در خصوص ارائه‌ی نسخه‌ی دسکتاپ این شبیه ساز تغییراتی داشته که مهم‌ترین آنها عدم انتشار API برای نسخه‌های جدید اندروید و اعمال محدودیت ۱ ماهه برای نسخه‌ی رایگان (Personal) هستند. از این به بعد تمرکز تیم Genymotion بر ارائه‌ی خدمات بر بستر Cloud است که هزینه‌های آن برای برنامه نویسان ایرانی بسیار بالاست.
در این مدت مشکلات AVD مخصوصا مساله‌ی سرعت اجرا هم تا حدود زیادی رفع شد و با توجه به شرایط فعلی، استفاده از شبیه ساز داخلی اندروید استودیو منطقی‌ترین گزینه محسوب می‌شود. همین مساله باعث شد آموزش کار با امولاتور داخلی اندروید استودیو و AVD را تهیه کنم.

نصب امولاتور اندروید استودیو

امولاتور اندروید استودیو به صورت پیش‌فرض فعال نیست و باید از طریق SDK Manager نصب شود. همانطور که در آموزش نصب و راه اندازی اندروید استودیو گفته شد، امکان نصب آفلاین گزینه‌های Emulator و HAXM وجود ندارد و صرفا باید به صورت آنلاین نصب انجام شود.
همچنین هنگام نصب اندروید استودیو باید گزینه‌ی Android Virtual Device انتخاب شده باشد در غیر اینصورت امکان استفاده از دیوایس مجازی یا AVD وجود نخواهد داشت:

پس از اطمینان از برقراری ارتباط اینترنت و تغییر IP برای عبور از تحریم ایران، SDK Manager را باز می‌کنم. اگر برای تغییر IP در اندروید استودیو نیاز به راهنمایی دارید این آموزش را مطالعه کنید.
گزینه Android Emulator را انتخاب و تایید می‌کنم تا دانلود و نصب آن شروع شود.

یک ابزار جانبی با نام Intel x86 Emulator Accelerator (Haxm) در لیست SDK وجود دارد که استفاده از آن بر روی پردازنده‌های اینتل باعث افزایش سرعت شبیه ساز می‌شود. بنابراین در صورتی که پردازنده شما Intel باشد حتما این ابزار را هم نصب کنید.

در این مرحله حداکثر میزانی از RAM که به امولاتور باید اختصاص داده شود را تعیین می‌کنیم که من همان عدد پیش‌فرض یعنی ۲ گیگابایت را انتخاب می‌کنم. البته این عدد بعداً هم قابل تغییر است.

نصب HAXM هم به پایان رسید و حالا می‌توانیم از شبیه ساز و AVD استفاده کنیم.
اگر به یاد داشته باشید قبلا در جلسه‌ی آموزش نصب اندروید استودیو توضیح دادیم که در SDK Platforms برای هر API چند System image مختلف وجود دارد که این سیستم ایمیج‌ها برای شبیه ساز داخلی اندروید استودیو استفاده می‌شود:

همانطور که در تصویر فوق مشاهده می‌کنید برای Android 12 به تعداد ۹ عدد System Image وجود دارد. توضیحات مربوط به هر سیستم ایمیج قبلا در قسمت توضیحات SDK در آموزش نصب اندروید استودیو قید شده بنابراین نیازی به تکرار نیست.
امکان دانلود و نصب هرکدام از سیستم ایمیج‌ها از طریق SDK Manager وجود دارد اما برای جلوگیری از انتخاب گزینه اشتباه توصیه می‌کنم دانلود را در محیط AVD انجام دهید. در AVD سیستم ایمیج مناسب شما در تب Recommended قرار می‌گیرد و از دانلود سیستم ایمیج‌های غیر ضروری و حجم بالا جلوگیری می‌کند.
گزینه Device Manager را از منوی تولبار یا نوار سمت راست اندروید استودیو انتخاب می‌کنم:

پنجره Device Manager باز شد:

در دیوایس منیجر دو تب Virtual (مجازی) و Physical (فیزیکی) وجود دارد. تب Virtual برای مدیریت دیوایس‌های مجازی استفاده می‌شود. در حال حاضر هیچ دیوایس مجازی در لیست وجود ندارد.
روی دکمه Create device یا لینک Create Virtual device کلیک می‌کنم تا پنل ساخت دیوایس مجازی باز شود:

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

در این مرحله باید نسخه‌ی system image مدنظر خود را انتخاب کنیم. برای مثال من قصد دارم دیوایس را با API 31 یعنی Android 12 بسازم. بنابراین همین API را باید انتخاب کنم اما در حال حاضر این API و تمامی API های دیگر یک گزینه دانلود مقابلشان قرار داده شده که نشان می‌دهد سیستم ایمیج هیچکدام دانلود و نصب نشده.
روی گزینه Download اندروید ۱۲ کلیک می‌کنم:

دانلود system image آغاز شد. خبر خوب اینکه مانند سایر ابزار SDK و برخلاف Emulator و HAXM فایل‌های مربوط به system image را می‌توان در خارج از محیط اندروید استودیو دانلود و به صورت آفلاین به SDK اضافه کرد.
با توجه به حجم بالای سیستم ایمیج‌ها (حدود ۱٫۵ گیگابایت) و لزوم استفاده از ابزار تغییر IP احتمال شکست دانلود بالاست بنابراین توصیه می‌کنم لینک فایل سیستم ایمیج را از قسمت بالا کپی کرده و با استفاده از یک برنامه مدیریت دانلود، دریافت کنید.
هرچند بازهم برای دانلود فایل نیاز به استفاده از ابزار تغییر IP وجود دارد اما در صورت استفاده از برنامه‌های مدیریت دانلود، چنانچه فرایند دانلود در هر نقطه قطع شود، می‌توان مجدد دانلود را از همان نقطه ادامه داد در حالی که در اندروید استودیو دانلود از ابتدا آغاز خواهد شد.
اگر همچنان قصد دارید دانلود به صورت خودکار و در محیط اندروید استودیو انجام شود فقط کافیست صبر کنید تا دانلود فایل به اتمام برسد.
اما من ترجیح می‌دهم فایل را جداگانه دانلود و سپس به محل نصب SDK منتقل کنم. بنابراین لینک فایل را کپی و فرایند دانلود را متوقف می‌کنم.
پوشه SDK را باز می‌کنم:

مشاهده می‌کنید یک پوشه با نام system-images در SDK من وجود دارد. علت اینکه این پوشه قبلا ساخته شده این است که من در قسمت قبل یک سیستم ایمیج را برای دانلود انتخاب کردم و فرایند دانلود آغاز شد.
به محض شروع دانلود، پوشه‌های لازم برای قرارگیری سیستم ایمیج‌ها ایجاد می‌شود حتی اگر دانلود متوقف شود.
بنابراین اگر فایل سیستم ایمیج را قبلا دانلود کرده‌اید یا لینک آن را در اختیار دارید و نیازی به انجام مراحل قبل برای دریافت لینک دانلود ندارید، این پوشه هم خودکار ساخته نشده و خودتان باید آنرا با همین نام ایجاد کنید.

وارد پوشه system-images می‌شوم:

یک پوشه با نام android-31 وجود دارد که مربوط به Android 12 است که در AVD برای دانلود انتخاب کرده بودم. داخل این پوشه به ترتیب به این شکل ساخته شده:

حالا کافیست پوشه x86_64 را حذف کرده و پوشه‌ای با همین نام که در فایل زیپ سیستم ایمیج قرار دارد را جایگزین کنم. نام فایلی که من دانلود کردم x86_64-31_r09.zip است. در نامگذاری فایل سیستم ایمیج از جزئیات آن استفاده شده است.
X86_64 یعنی دیوایسی که با این سیستم ایمیج ساخته شود از اپلیکیشن‌های ۶۴ بیتی هم پشتیبانی می‌کند. عدد ۳۱ مربوط به نسخه API است و r09 یعنی فایل سیستم فعلی نهمین نسخه بروزرسانی شده از این سیستم ایمیج است.
به این ترتیب می‌توان یک سیستم ایمیج را بدون نیاز به دانلود آن در محیط اندروید استودیو نصب کرد.
در اینجا چون دانلود سیستم ایمیج اندروید ۱۲ برای لحظه‌ای آغاز شده بود، با اینکه آنرا متوقف کردم، تمامی پوشه‌های مربوط به آن به طور خودکار ساخته شد. اما اگر به هر دلیلی این فرایند انجام نشود، این پوشه‌ها باید به صورت دستی ایجاد شود.
برای مثال این سیستم ایمیج مربوط به API 31 بود بنابراین نام پوشه اصلی آن android-31 است. دیوایس Pixel 2 که در AVD انتخاب کردیم از نوعی بود که از Play Store پشتیبانی می‌کرد بنابراین پوشه بعدی با نام google_apis_playstore ساخته شده. اگر دیوایس از نوعی باشد که پلی استور را پشتیبانی نمی‌کند پوشه را با نام google_apis می‌سازیم.

پوشه x86_64 که از فایل زیپ دانلود شده خروجی گرفتم را جایگزین این پوشه کرده و به پنجره ساخت دیوایس برمی‌گردم. با توجه به اینکه سیستم ایمیج به صورت آفلاین نصب شد یکبار با استفاده از دکمه Refresh لیست سیستم ایمیج‌ها را بروز می‌کنم:

مشاهده می‌کنید API 31 نصب و گزینه Download حذف شده است. همچنین با انتخاب این API دکمه Next فعال شده و می‌توان به مرحله بعد رفت.

در این مرحله جزئیات دیوایس مجازی را می‌توان تغییر داد. مانند نام دیوایس و وضعیت افقی یا عمودی بودن دیوایس هنگام اجرا. با انتخاب گزینه Show Advanced Settings سایر تنظیمات فعال می‌شود.
با کلیک روی Finish دیوایس ساخته شده و به لیست دیوایس‌های مجازی من اضافه می‌شود:

در قسمت Actions چهار گزینه برای هر دیوایس وجود دارد. گزینه اول برای استارت دیوایس است. از زمان استارت دیوایس تا بوت شدن اندروید حدود ۲۰ ثانیه زمان لازم است که البته به سخت‌افزار شما بستگی دارد.

حالا می‌توان پروژه را روی این دیوایس Run یا Debug کرد. در نوار بالای دیوایس چند گزینه وجود دارد که کاربرد هرکدام مشخص است. یک گزینه‌ی ۳ نقطه هم وجود دارد که تنظیمات دستگاه مانند موقعیت مکانی، میکروفون، دوربین و سنسورها را در اختیار برنامه نویس قرار می‌دهد:

این آموزش هم به پایان رسید. موفق و پیروز باشید.

دانلود System Image ها

توجه داشته باشید دانلود این فایل‌ها تنها در صورتی لازم است که قصد نصب آفلاین سیستم ایمیج‌ها را داشته باشید.

تاریخ بروزرسانی فایل‌ها : ۱۴۰۱/۰۴/۲۵

» دانلود System Image Android 12 Google Play x86_64 (API 31) با حجم ۱٫۳ گیگابایت | لینک کمکی

» دانلود System Image Android 7 Google Play x86 (API 24) با حجم ۷۷۵ مگابایت | لینک کمکی

نوشته کار با امولاتور و ساخت دیوایس مجازی (AVD) اولین بار در اندروید استودیو پدیدار شد.

View Binding چیست؟

به نام خدا. View Binding یکی از امکانات زیر مجموعه‌ی Jetpack است که در کنفرانس IO گوگل در سال ۲۰۱۹ معرفی و در سال ۲۰۲۰ در Android Studio 3.6 و به عبارت دیگر Gradle 3.6 امکان فعالسازی و استفاده از آن مهیا شد. بنابراین استفاده از این قابلیت تنها از این نسخه و به بالا امکان پذیر است.
اولین مزیت View Binding این است که برای فعالسازی روی اندروید استودیو نیازی به افزودن (import) یک کتابخانه اضافی به پروژه اندرویدی نیست و درون پلاگین Gradle اندروید استودیو تعبیه شده است. بنابراین صرفا لازم است در فایل گریدلِ پروژه آنرا فعال کنیم.
همانطور که در ابتدای جلسه اشاره شد، View Binding جایگزینی برای تعریف view ها به شیوه سنتی آن یعنی استفاده از findViewById به شمار می‌رود.
اگر در حالت عادی در یک لایه XML تعداد ۱۰ عدد view (مانند Button، TextView، EditText و…) داشته باشیم برای هرکدام و به صورت جداگانه باید با استفاده از findViewById آنها را در Activity یا Fragment تعریف کنیم. چیزی شبیه به اکتیویتی زیر:

package ir.android_studio.testapp;

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

public class MainActivity extends AppCompatActivity {

    private Button sendBtn;
    private TextView textView;
    private EditText editText;

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

        sendBtn = findViewById(R.id.send_btn);
        textView = findViewById(R.id.txt_view);
        editText = findViewById(R.id.edit_text);

    }
}

علاوه بر نیاز به نوشتن و تکرار کدهای اضافی، ایرادات و باگ‌هایی این شیوه‌ی معرفی view ها دارد که با جایگزینی آن با View Binding این ایرادات مرتفع می‌گردد.
با استفاده از View Binding نیازی به تعریف view ها توسط برنامه نویس نبوده و فراخوانی view ها به صورت مستقیم توسط id (شناسه) آنها انجام می‌شود!

مقایسه View Binding در اندروید با سایر ابزارها و روش‌ها

برای تعریف view ها در اندروید چندین روش و کتابخانه وجود دارد که هرکدام مزایا و معایب مخصوص به خود را داشته و البته در نهایت به این نتیجه می‌رسیم که استفاده از View Binding در اندروید بهینه ترین روش فعلی خواهد بود.
در ادامه برای درک بهتر برتری View Binding نسبت به رقبا، به بررسی هرکدام می‌پردازیم:

findViewById

نیازی به معرفی نیست بنابراین به بررسی مزایا و معایب می‌پردازم:
عدم تاثیر در سرعت بیلد: شاید تنها مزیت آن را بتوان عدم تاثیر بر سرعت بیلد پروژه دانست چرا که هنگام اجرای برنامه کار می‌کند. اما این مزیت در برابر معایب متعدد آن اصلا قابل توجیه نیست.
کدهای اضافی: اولین امتیاز منفی این است که به ازاء هر view می‌بایست یک متغیر جداگانه ایجاد شود که طبیعتا حجم کدهای ما را افزایش خواهد داد.
Type safety نیست: واژه type به معنی “نوع” و safety به معنی “ایمنی” است. Type safety نبودن findViewById به این معنی است که در هنگام تعریف کردن یک view امکان بروز اشتباه در تعیین نوع آن وجود دارد.
برای مثال ممکن است view از جنس TextView باشد و ما اشتباها آن را در یک متغیر از جنس EditText تعریف کنیم.
Null safe نیست: اگر یک view موجود در layout فقط در شرایطی خاص در دسترس باشد ممکن است با یک خطای NullPointerException مواجه شویم. زیرا findViewById وضعیت نال بودن یا نبودن view را در شرایط مختلف بررسی نمی‌کند.
برای مثال حالتی را درنظر بگیرید که دو نسخه از activity_main.xml در پروژه داریم که یکی برای حالت عادی (صفحه عمودی یا portrait) و دیگری برای حالت افقی (landscape) استفاده می‌شود. چنانچه یک view در هردو layout مشترک نبوده و تنها در حالت portrait بکار رفته باشد هنگام قرار گرفتن دستگاه کاربر در حالت landscape می‌تواند سبب بروز خطای null شود.

کتابخانه ButterKnife

تا قبل از معرفی Data Binding توسط تیم اندروید، کتابخانه ButterKnife یکی از پرکاربردترین ابزار برای این منظور به شمار می‌رفت. البته کاربرد این کتابخانه محدود به bind (متصل) کردن view ها نمی‌شود و برای resource ها مانند رشته‌ها، رنگ‌ها و سایزها نیز کاربرد دارد. اما در این جلسه تنها قسمت مربوط به view ها مدنظر ماست.
کاهش حجم کدها: استفاده از این کتابخانه حجم کدها را نسبت به findViewById کاهش داده و به عبارتی کدهای تمیز تری می‌نویسیم. در این روش، به وسیله Annotation ها (حاشیه نویسی) می‌توان view های مدنظر را تعریف کرد. سه view ای که در قسمت قبل توسط findViewById تعریف شده بود را اینبار با استفاده از ButterKnife تعریف می‌کنم.
پس از اضافه کردن کتابخانه به پروژه، توسط annotation با نام @BindView هرکدام از view ها قابل تعریف است:

package ir.android_studio.testapp;

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

import butterknife.BindView;

public class MainActivity extends AppCompatActivity {

    @BindView(R.id.send_btn) Button sendBtn;
    @BindView(R.id.txt_view) TextView textView;
    @BindView(R.id.edit_text) EditText editText;

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

    }
}

Type safety نیست: مانند findViewById کتابخانه ButterKnife هم type safety نیست و id هر نوع view ای را می‌توان به هر نوع View در کلاس جاوا متصل کرد. بنابراین ممکن است در هنگام اجرا با ارور Exception برخورد کنیم.
کاهش سرعت بیلد: از آنجایی که در حین کامپایل پروژه یک پردازشگر Annotation برای تولید (generate) کدها اجرا می‌شود در سرعت بیلد تاثیر منفی می‌گذارد. هرچند این کاهش سرعت بیلد چیزی نیست که ما را از استفاده یک کتابخانه منصرف کند زیرا به قول معروف مزایای آن بر معایبش می‌چربد. البته نه الان که View Binding را داریم!

Data Binding

تفاوت اساسی Data Binding با دو مورد قبل در این است که پس از فعالسازی این قابلیت در پروژه اندرویدی، به ازاء هر layout یا سایر resource ها به صورت خودکار یک کلاس ایجاد (generate) می‌شود. در این کلاس‌ها تمامی عناصر به صورت خودکار تعریف و مقدار دهی شده و به سادگی می‌توانیم در اکتیویتی یا فرگمنت به آنها دسترسی داشته باشیم.
کاهش حجم کدها: فعالسازی و استفاده از Data Binding نسبت به دو گزینه قبل نیاز به نوشتن کد کمتری دارد در نتیجه کدهای تمیزتری خواهیم داشت.
کاهش سرعت بیلد: در کلاس‌های ساخته شده توسط Data Binding از Annotation ها برای تعریف منابع استفاده می‌شود بنابراین مانند ButterKnife این مساله در کاهش سرعت build شدن پروژه تاثیرگذار خواهد بود.
Type safety و Null safe است: هردو مورد در Data Binding صدق می‌کند و از این بابت جای نگرانی نداریم.
در خصوص Data Binding بیشتر از این به بیان جزئیات نمی‌پردازم.

View Binding

رسیدیم به هدف! همانطور که در ابتدای مبحث گفته شد View Binding به نوعی زیر مجموعه‌ی Data Binding محسوب می‌شود که کاربرد آن در حذف findViewById خلاصه شده و به همین جهت علاوه بر ساده تر شدن فرآیند، نسبت به Data Binding خروجی بهینه‌تری را در اختیار ما قرار می‌دهد.
کاهش حجم کدها: با فعالسازی و استفاده از View Binding حجم کد مورد نیاز برای استفاده از view ها به حداقل ممکن می‌رسد و در بین این ۴ گزینه بالاترین امتیاز را به خود اختصاص داده است. تنها با نوشتن id هر view در اکتیویتی یا فرگمنت به view مربوطه دسترسی خواهیم داشت!
افزایش سرعت بیلد: شیوه کار View Binding هم مانند Data Binding است و با فعالسازی آن به ازاء هر layout یک کلاس ایجاد شده و تمامی view های آن درون کلاس به صورت خودکار تعریف می‌شود. اما در اینجا خبری از پردازش annotation ها نیست و در نتیجه سرعت بیلد به نسبت Data Binding بالاتر خواهد بود.
Type safety و Null safe است: این دو مورد را از پدر خودش یعنی Data Binding به ارث برده و با یکدیگر مشترک هستند.

حالا که گزینه‌های مختلف را بررسی کردیم و فهمیدیم بهترین گزینه در حال حاضر View Binding است در ادامه جلسه این قابلیت را در قالب یک پروژه بررسی و تمرین می‌کنیم.

ساخت پروژه View Binding و بررسی آن

ابتدا طبق مبحث آموزش ساخت پروژه در اندروید استودیو یک پروژه اندرویدی با نام ViewBinding می‌سازم. اکتیویتی را از نوع Empty Activity و زبان را Java انتخاب کردم.
در ابتدا و قبل از هرچیز لازم است قابلیت View Binding را در پروژه خود در اندروید استودیو فعال کنیم.

فعالسازی View Binding در اندروید استودیو

همانطور که قبلا اشاره شد این قابلیت به صورت پیش فرض در گریدل نسخه ۳٫۶ به بالا تعبیه شده و برای فعالسازی آن نیازی به اضافه کردن کتابخانه به پروژه نیست.
برای فعالسازی کافیست بلاک زیر را درون بلاک android در فایل build.gradle (project) اضافه و سپس پروژه را Sync کنم:

buildFeatures {
    viewBinding = true
}

viewBinding {
    enabled = true
}

پیاده سازی View Binding در اکتیویتی

همانطو که قبلا گفته شد، با فعالسازی View Binding به ازاء هر layout موجود در پروژه یک کلاس جداگانه ایجاد می‌شود. نام هر کلاس از نام layout مربوط به آن گرفته می‌شود که البته به صورت camel case نوشته شده و پسوند Binding هم به انتهای آن اضافه می‌شود.
برای مثال در این پروژه ما یک layout با نام activity_main.xml داریم. کلاسی که برای این layout ایجاد می‌شود ActivityMainBinding.java نام دارد. به عنوان یک مثال دیگر چنانچه در آینده یک layout با نام activity_map.xml به پروژه اضافه کنیم، کلاس ایجاد شده ActivityMapBinding.java نام خواهد داشت.
در این کلاس به ازاء هر view (ویجت) ای که در activity_main.xml وجود داشته و یک id به آن اختصاص داده شده باشد، یک متغیر ایجاد می‌شود و ما در اکتیویتی به آن دسترسی خواهیم داشت.
در layout پیش فرض پروژه یک View Group از جنس ConstraintLayout و یک TextView وجود دارد که البته برای TextView شناسه (id) به صورت پیش فرض تعریف نشده. بنابراین برای آنکه به این view دسترسی داشته باشم یک id به آن اختصاص می‌دهم:

activity_main.xml

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".MainActivity">

    <TextView
      android:id="@+id/txt_view"
      android:layout_width="wrap_content"
      android:layout_height="wrap_content"
      android:text="Hello World!"
      app:layout_constraintBottom_toBottomOf="parent"
      app:layout_constraintLeft_toLeftOf="parent"
      app:layout_constraintRight_toRightOf="parent"
      app:layout_constraintTop_toTopOf="parent" />

  </androidx.constraintlayout.widget.ConstraintLayout>

در مرحله بعد لازم است یک آبجکت (شیء) از کلاس ActivityMainBinding داخل اکتیویتی تعریف کنیم تا به view ها به صورت مستقیم دسترسی داشته باشیم.

مشاهده می‌کنید کلاس ActivityMainBinding توسط اندروید استودیو شناسایی می‌شود. یعنی کلاس قبلا ساخته شده و قابل استفاده است.

MainActivity.java

package ir.android_studio.viewbinding;

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

import ir.android_studio.viewbinding.databinding.ActivityMainBinding;

public class MainActivity extends AppCompatActivity {

    private ActivityMainBinding mainBinding;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        mainBinding = ActivityMainBinding.inflate(getLayoutInflater());

        setContentView(R.layout.activity_main);


    }
}

نام دلخواه mainBinding را برای کلاس انتخاب کردم. سپس درون متد onCreate و قبل از setContentView توسط متد inflate آنرا مقداردهی کردم.
حالا به View Group اصلی layout و تمام view هایی که قبلا به layout اضافه شده و یا بعد از این اضافه شود دسترسی خواهیم داشت. البته مجدد تاکید می‌کنم view هایی که دارای ویژگی id باشند. بجز عنصر اصلی یا ریشه‌ی layout که نیازی به id نداشته و در متغیری با نام root ذخیره شده و توسط getRoot در دسترس است. در اینجا عنصر ریشه ما یک ConstraintLayout است که قبلا در جلسه آموزش کار با ConstraintLayout با آن آشنا شدیم.
ابتدا لازم است getRoot را به متد setContentView پاس بدهیم تا به اکتیویتی اعلام شود از طریق آبجکت Binding ای که ساخته‌ایم به layout دسترسی داشته باشد. getRoot را جایگزین R.layout.activity_main می‌کنم:

setContentView(mainBinding.getRoot());

حالا برای تست View Binding با استفاده از متد setText یک متن را روی txt_view چاپ می‌کنم:

protected void onCreate(Bundle savedInstanceState) {
    super.onCreate(savedInstanceState);

    mainBinding = ActivityMainBinding.inflate(getLayoutInflater());

    setContentView(mainBinding.getRoot());

    mainBinding.txtView.setText("تست ViewBinding");

}

پروژه را روی امولاتور (شبیه ساز) اندرویدی اجرا می‌کنم:

طبق تصویر فوق هم layout نمایش داده شد و هم متنی که در setText قرار داده بودیم.
برای تمرین و آشنایی بیشتر، یک Button به layout اضافه کرده و در اکتیویتی یک setOnClickListener برای آن تعریف می‌کنم. قبلا در آموزش کار با رویدادها در اندروید با این متد آشنا شده‌ایم. خط مربوط به setText را به درون رویداد مربوط به دکمه منتقل می‌کنم تا بعد از کلیک روی دکمه اجرا شود:

activity_main.xml

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".MainActivity">

    <Button
        android:id="@+id/set_btn"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_marginTop="80dp"
        android:text="جایگذاری متن"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toTopOf="parent" />

    <TextView
        android:id="@+id/txt_view"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="Hello World!"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toBottomOf="@+id/set_btn" />

</androidx.constraintlayout.widget.ConstraintLayout>

MainActivity.java

package ir.android_studio.viewbinding;

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

import ir.android_studio.viewbinding.databinding.ActivityMainBinding;

public class MainActivity extends AppCompatActivity {

    private ActivityMainBinding mainBinding;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        mainBinding = ActivityMainBinding.inflate(getLayoutInflater());

        setContentView(mainBinding.getRoot());

        mainBinding.setBtn.setOnClickListener(view -> {

            mainBinding.txtView.setText("تست ViewBinding");

        });

    }
}

مجدد پروژه را اجرا کرده و روی دکمه جایگذاری متن کلیک می‌کنم:

دسترسی به کلاس‌های View Binding

اگر مایل بودید به محتوای کلاس‌های ساخته شده توسط View Binding دسترسی داشته باشید، بعد از بیلد شدن پروژه (یعنی هنگام اجرای پروژه روی دیوایس یا گزینه Rebuild Project در تب Build و یا گرفتن خروجی APK از پروژه) در مسیر زیر فایل کلاس‌ها در دسترس هستند:

برای نمایش محتوای دایرکتوری build لازم است نحوه نمایش پروژه در حالت Project و یا Project Files قرار گیرد. البته در پوشه‌ای که پروژه ذخیره شده هم می‌توان به فایل‌ها دسترسی داشت.

محتوای فعلی کلاس ActivityMainBinding.java پروژه من به اینصورت است:

ActivityMainBinding.java

// Generated by view binder compiler. Do not edit!
package ir.android_studio.viewbinding.databinding;

import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;
import android.widget.Button;
import android.widget.TextView;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.constraintlayout.widget.ConstraintLayout;
import androidx.viewbinding.ViewBinding;
import ir.android_studio.viewbinding.R;
import java.lang.NullPointerException;
import java.lang.Override;
import java.lang.String;

public final class ActivityMainBinding implements ViewBinding {
  @NonNull
  private final ConstraintLayout rootView;

  @NonNull
  public final Button setBtn;

  @NonNull
  public final TextView txtView;

  private ActivityMainBinding(@NonNull ConstraintLayout rootView, @NonNull Button setBtn,
      @NonNull TextView txtView) {
    this.rootView = rootView;
    this.setBtn = setBtn;
    this.txtView = txtView;
  }

  @Override
  @NonNull
  public ConstraintLayout getRoot() {
    return rootView;
  }

  @NonNull
  public static ActivityMainBinding inflate(@NonNull LayoutInflater inflater) {
    return inflate(inflater, null, false);
  }

  @NonNull
  public static ActivityMainBinding inflate(@NonNull LayoutInflater inflater,
      @Nullable ViewGroup parent, boolean attachToParent) {
    View root = inflater.inflate(R.layout.activity_main, parent, false);
    if (attachToParent) {
      parent.addView(root);
    }
    return bind(root);
  }

  @NonNull
  public static ActivityMainBinding bind(@NonNull View rootView) {
    // The body of this method is generated in a way you would not otherwise write.
    // This is done to optimize the compiled bytecode for size and performance.
    int id;
    missingId: {
      id = R.id.set_btn;
      Button setBtn = rootView.findViewById(id);
      if (setBtn == null) {
        break missingId;
      }

      id = R.id.txt_view;
      TextView txtView = rootView.findViewById(id);
      if (txtView == null) {
        break missingId;
      }

      return new ActivityMainBinding((ConstraintLayout) rootView, setBtn, txtView);
    }
    String missingId = rootView.getResources().getResourceName(id);
    throw new NullPointerException("Missing required view with ID: ".concat(missingId));
  }
}

ملاحظه می‌کنید برای همه متغیرها انوتیشین @NonNull قید شده یعنی هیچکدام از آیتم‌ها تحت هیچ شرایطی نال نخواهند شد.
اما فرض کنید در پروژه خود یک activity_main.xml دیگر هم داشته باشیم که مربوط به طراحی صفحه در حالت Landscape (افقی) باشد و در این حالت یکی از view ها را حذف کرده باشیم. یا بلعکس یک view در این حالت اضافه کرده باشیم که قرار نیست در layout اصلی یعنی حالت عمودی وجود داشته باشد. در اینصورت بجای @NonNull انوتیشین @Nullable جایگزین خواهد شد که نشان می‌دهد این view می‌تواند در شرایطی نال باشد. بنابراین وضعیت نال مدیریت شده و به اصطلاح Null safe هستند.
به متد انتهای کلاس دقت کنید:

@NonNull
public static ActivityMainBinding bind(@NonNull View rootView) {
  // The body of this method is generated in a way you would not otherwise write.
  // This is done to optimize the compiled bytecode for size and performance.
  int id;
  missingId: {
    id = R.id.set_btn;
    Button setBtn = rootView.findViewById(id);
    if (setBtn == null) {
      break missingId;
    }

    id = R.id.txt_view;
    TextView txtView = rootView.findViewById(id);
    if (txtView == null) {
      break missingId;
    }

    return new ActivityMainBinding((ConstraintLayout) rootView, setBtn, txtView);
  }
  String missingId = rootView.getResources().getResourceName(id);
  throw new NullPointerException("Missing required view with ID: ".concat(missingId));
}

حدس می‌زنم انتظارش را نداشتید اینجا با findViewById مواجه شوید! اما واقعیت جز این نیست 🙂
View Binding از متد findViewById برای اتصال view ها به اکتیویتی استفاده می‌کند و انجام این مرحله تکراری و زجر آور را از روی دوش برنامه نویس برمی‌دارد. علاوه بر آن، در خصوص type و null هم ما را ایمن نگه می‌دارد.

View Binding و layout های include شده

اگر بخاطر داشته باشید در جلسه آموزش کار با Navigation Drawer با استفاده از تگ include یک layout را درون layout اصلی برنامه اضافه کردیم.
دسترسی به view های layout ای که در layout یک اکتیویتی include شده امکان پذیر است. یک layout جدید با نام layout_bottom.xml به پروژه اضافه کرده و یک TextView با شناسه btm_txt داخل آن تعریف می‌کنم:

layout_bottom.xml

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout 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">

    <TextView
        android:id="@+id/btm_txt"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="متن پایینی"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toTopOf="parent" />
    
</androidx.constraintlayout.widget.ConstraintLayout>

سپس layout را درون activity_main.xml توسط تگ include اضافه می‌کنم. دقت داشته باشید برای دسترسی به layout ضمیمه شده و view های درون آن توسط View Binding حتما برای تگ include هم باید یک id تعریف شود. من شناسه include_layout را انتخاب کردم:

activity_main.xml

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".MainActivity">

    <Button
        android:id="@+id/set_btn"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_marginTop="80dp"
        android:text="جایگذاری متن"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toTopOf="parent" />

    <TextView
        android:id="@+id/txt_view"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_marginTop="252dp"
        android:text="Hello World!"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toBottomOf="@+id/set_btn" />

    <include
        layout="@layout/layout_bottom"
        android:id="@+id/include_layout"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintTop_toBottomOf="@+id/txt_view"
        app:layout_constraintVertical_bias="0.706"
        tools:layout_editor_absoluteX="-16dp" />

</androidx.constraintlayout.widget.ConstraintLayout>

حالا برای دسترسی به btm_txt در layout_bottom به اینصورت عمل می‌کنیم:

mainBinding.includeLayout.btmTxt

includeLayout همان شناسه include_layout است.
برای مثال متد setText را برای این TextView استفاده می‌کنم:

mainBinding.setBtn.setOnClickListener(view -> {

    mainBinding.txtView.setText("تست ViewBinding");
    mainBinding.includeLayout.btmTxt.setText("تعویض متن پایینی");

});

برای layout_bottom.xml هم یک کلاس ایجاد شده که LayoutBottomBinding.java نام دارد اما به دلیل اینکه در اینجا layout را درون یک layout دیگر include کرده‌ایم که قبلا یک آبجکت از آن در اکتیویتی ساخته شده، بدون نیاز به ساخت آبجکت جدید از layout زیرمجموعه، می‌توان به آن دسترسی داشت.

با اجرای پروژه و کلیک روی دکمه جایگذاری متن، متن این TextView هم تغییر می‌کند:

غیر فعال کردن View Binding برای یک لایه (layout) خاص

ممکن است در پروژه خود برای یک یا چند layout نیازی به ساخت کلاس View Binding نداشته باشیم. با توجه به اینکه افزایش تعداد کلاس‌ها در نهایت موجب کاهش سرعت بیلد و همچنین افزایش حجم پروژه می‌شود لذا می‌طلبد برای لایه‌هایی که به صورت ایستا (static) هستند و کاری با view های داخل آن نداریم، قابلیت View Binding را غیر فعال کنیم.
برای انجام این کار کافیست خط زیر به تگ layout ریشه آن اضافه شود:

tools:viewBindingIgnore="true"

برای مثال من یک لایه با نام layout_top.xml در پروژه ایجاد کرده‌ام و با توجه به ایستا بودن محتوای آن قصد دارم View Binding را روی این فایل غیر فعال کنم:

layout_top.xml

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    xmlns:tools="http://schemas.android.com/tools"
    tools:viewBindingIgnore="true">

</androidx.constraintlayout.widget.ConstraintLayout>

واژه ignore به معنی “نادیده گرفتن” و “رد کردن” است بنابراین چنانچه برای این ویژگی مقدار true تعیین شود، قابلیت View Binding برای layout مدنظر نادیده گرفته خواهد شد.

پیاده سازی View Binding روی فرگمنت

قبلا در مبحث فرگمنت‌ها در اندروید با کاربرد Fragment آشنا شدیم. استفاده از View Binding در فرگمنت تفاوت زیادی با اکتیویتی ندارد.
یک فرگمنت با نام TestFragment به پروژه اضافه می‌کنم. سپس در layout فرگمنت یعنی fragment_text.xml یک TextView با شناسه fragment_txt تعریف می‌کنم:

fragment_test.xml

<?xml version="1.0" encoding="utf-8"?>
<FrameLayout 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"
    tools:context=".TestFragment">

    <!-- TODO: Update blank fragment layout -->
    <TextView
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:text="متن پیش فرض فرگمنت"
        android:id="@+id/fragment_txt"/>

</FrameLayout>

سپس در کلاس فرگمنت مانند آنچه قبلا در اکتیویتی انجام شد یک آبجکت از کلاسی که View Binding برای layout فرگنت ایجاد کرده می‌سازم:

TextFragment.java

package ir.android_studio.viewbinding;

import android.os.Bundle;
import androidx.fragment.app.Fragment;
import android.view.LayoutInflater;
import android.view.View;
import android.view.ViewGroup;

import ir.android_studio.viewbinding.databinding.FragmentTestBinding;

public class TestFragment extends Fragment {

    private FragmentTestBinding frgBinding;

    @Override
    public View onCreateView(LayoutInflater inflater, ViewGroup container,
                             Bundle savedInstanceState) {

        //return inflater.inflate(R.layout.fragment_test, container, false);

        frgBinding = FragmentTestBinding.inflate(inflater, container, false);

        return frgBinding.getRoot();

    }

    @Override
    public void onDestroyView() {
        super.onDestroyView();

        frgBinding = null;

    }
}

مطابق کد فوق ابتدا از کلاس FragmentTestBinding یک نمونه با نام frgBinding ساخته‌ام. سپس inflate اصلی فرگمنت را حذف (کامنت) کرده و inflate مربوط به View Binding را مانند اکتیویتی و البته اندکی تفاوت بجای آن تعریف کرده‌ام. در خط بعد هم متد getRoot برگردانده یا return شد.
همچنین متد onDestroyView که مربوط به چرخه حیات فرگمنت هست را اضافه و درون آن آبجکت ساخته شده از View Binding را null می‌کنم تا هنگام حذف فرگمنت از اکتیویتی، این آبجکت نال شود.
یک متد setText برای TextView فرگمنت در onCreateView و قبل از دستور return تعریف می‌کنم:

public View onCreateView(LayoutInflater inflater, ViewGroup container,
                         Bundle savedInstanceState) {
    
    //return inflater.inflate(R.layout.fragment_test, container, false);

    frgBinding = FragmentTestBinding.inflate(inflater, container, false);

    frgBinding.fragmentTxt.setText("متن جدید فرگمنت");

    return frgBinding.getRoot();

}

در نهایت، فرگمنت را در activity_main.xml تعریف می‌کنم. از اختصاص id به تگ fragment فراموش نکنید!

activity_main.xml

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout
    xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".MainActivity">

    <Button
        android:id="@+id/set_btn"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_marginTop="80dp"
        android:text="جایگذاری متن"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toTopOf="parent" />

    <TextView
        android:id="@+id/txt_view"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_marginTop="252dp"
        android:text="Hello World!"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toBottomOf="@+id/set_btn" />

    <include
        android:id="@+id/include_layout"
        layout="@layout/layout_bottom"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        app:layout_constraintTop_toBottomOf="@+id/txt_view"
        tools:layout_editor_absoluteX="-16dp" />

    <fragment
        android:id="@+id/fragment_one"
        android:name="ir.android_studio.viewbinding.TestFragment"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toBottomOf="@+id/include_layout" />

</androidx.constraintlayout.widget.ConstraintLayout>

با اجرای مجدد پروژه می‌بینیم که متن موجود در setText روی TextView جایگزین متن پیش فرض آن شده:

این جلسه هم به پایان رسید.
موفق و پیروز باشید.

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

https://developer.android.com/topic/libraries/view-binding
https://developer.android.com/topic/libraries/data-binding

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

نوشته خداحافظ findViewById؛ سلام View Binding اولین بار در اندروید استودیو پدیدار شد.

نحوه‌ دریافت پیامک در اپلیکیشن اندرویدی

به نام خدا. به طور کل با استفاده از دو کلاس SmsMessage و Cursor می‌توانیم به پیامک‌های موجود در دستگاه اندرویدی دسترسی داشته باشیم. البته روش متداول، استفاده از SmsMessage است. در ادامه به بررسی هر دو روش پرداخته و سپس به صورت عملی پیاده سازی می‌کنیم.
SmsMessage: کلاسی با نام SmsMessage در API 4 به سیستم عامل اندروید اضافه شده که وظیفه دسترسی به پیامک یا همان SMS را در دستگاه‌های اندرویدی بر عهده دارد.
البته از API 1 هم کلاسی با این نام وجود داشت (android.telephony.gsm.SmsMessage) که تنها از پروتکل GSM پشتیبانی می‌کرد. اما در API 4 این کلاس با android.telephony.SmsMessage جایگزین شد که از هر دو پروتکل GSM و CDMA پشتیبانی می‌کند.
همچنین برای شنود رویداد مربوط به دریافت پیامک لازم است از برودکست رسیور استفاده کنیم که قبلا در آموزش BroadcastReceiver در اندروید با این مبحث آشنا شدیم.
Cursor: علاوه بر کلاس SmsMessage با استفاده از کلاس Cursor هم می‌توان به آرشیو پیامک‌ها دسترسی داشت که با وجود کلاس SmsMessage استفاده از آن جایگاهی نخواهد داشت با این حال در انتهای آموزش به این مورد نیز اشاره مختصری خواهیم کرد.

ساخت پروژه دریافت SMS در اندروید استودیو

برای بررسی نحوه دریافت پیامک (SMS) در برنامه نویسی اندروید مطابق مبحث آموزش ساخت پروژه در اندروید استودیو یک پروژه اندرویدی با نام ReceiveSMS می‌سازم. اکتیویتی را از نوع Empty Activity و زبان را Java انتخاب کردم.

دریافت پیامک (SMS) توسط SmsMessage

اگر بخاطر داشته باشید در جلسه نحوه ارسال پیامک (SMS) در برنامه نویسی اندروید در مانیفست پروژه مجوز ارسال پیامک را تعریف کردیم. در این پروژه لازم است عکس آن یعنی مجوز دریافت SMS را تعریف کنیم:

<uses-permission android:name="android.permission.RECEIVE_SMS" />

AndroidManifest.xml

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

    <uses-permission android:name="android.permission.RECEIVE_SMS" />

    <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/Theme.ReceiveSMS">
        <activity android:name=".MainActivity">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />

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

</manifest>

در قدم بعد لازم است یک BroadcastReceiver ایجاد کنم. بر خلاف پروژه ارسال SMS که برودکست درون اکتیویتی و به صورت داینامیک رجیستر شد، در این جلسه برودکست را در کلاس مجزا تعریف کرده و همچنین رجیستر یا ثبت آن را به صورت استاتیک و درون Manifest انجام می‌دهم.
یک کلاس با نام SMSBroadcastReceiver به پروژه اضافه کرده و آنرا از BroadcastReceiver مشتق می‌کنم. سپس متد onReceive را اضافه می‌کنم:

SMSBroadcastReceiver.java

package ir.android_studio.receivesms;

import android.content.BroadcastReceiver;
import android.content.Context;
import android.content.Intent;

public class SMSBroadcastReceiver extends BroadcastReceiver {
    @Override
    public void onReceive(Context context, Intent intent) {
        
    }
}

سپس برودکست رسیور را در مانیفست پروژه ثبت می‌کنم:

<receiver android:name=".SMSBroadcastReceiver">
    <intent-filter>
        <action android:name="android.provider.Telephony.SMS_RECEIVED" />
    </intent-filter>
</receiver>

کد کامل مانیفست:
AndroidManifest.xml

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

    <uses-permission android:name="android.permission.RECEIVE_SMS" />

    <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/Theme.ReceiveSMS">
        <activity android:name=".MainActivity">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />

                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>
        <receiver android:name=".SMSBroadcastReceiver">
            <intent-filter>
                <action android:name="android.provider.Telephony.SMS_RECEIVED" />
            </intent-filter>
        </receiver>
    </application>

</manifest>

یک اکشن با نام android.provider.Telephony.SMS_RECEIVED در مانیفست تعریف کردیم. این اکشن وظیفه بررسی رویدادهای مربوط به دریافت پیامک را در سیستم عامل بر عهده دارد.
قبل از پیاده سازی کلاس SmsMessage قصد دارم صرفا عملکرد برودکست را بررسی کنم و مطمئن شوم action ای که در مانیفست تعریف کردم می‌تواند به دریافت پیامک واکنش نشان دهد. بنابراین در متد onReceive برودکست رسیور صرفا یک پیغام Toast تعریف می‌کنم:

public void onReceive(Context context, Intent intent) {

    Toast.makeText(context, "یک پیامک دریافت شد", Toast.LENGTH_SHORT).show();

}

با توجه به اینکه قصد دارم پروژه را روی یک دیوایس بالاتر از اندروید ۶ اجرا کنم، لازم است کدهای مربوط به Runtime Permission را مطابق آموزش Runtime Permission در اندروید به اکتیویتی اضافه کنم:

MainActivity.java

package ir.android_studio.receivesms;

import androidx.annotation.NonNull;
import androidx.appcompat.app.AlertDialog;
import androidx.appcompat.app.AppCompatActivity;
import androidx.core.app.ActivityCompat;
import androidx.core.content.ContextCompat;

import android.Manifest;
import android.content.DialogInterface;
import android.content.pm.PackageManager;
import android.os.Bundle;
import android.widget.Toast;

public class MainActivity extends AppCompatActivity {

    private final int SMS_REQUEST_CODE = 100;

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

        if (ContextCompat.checkSelfPermission(MainActivity.this, Manifest.permission.RECEIVE_SMS) != PackageManager.PERMISSION_GRANTED) {

            requestReceiveSMSpermission();

        } else {

            Toast.makeText(this, "مجوز قبلا دریافت شده", Toast.LENGTH_SHORT).show();

        }

    }

    private void requestReceiveSMSpermission() {

        if (ActivityCompat.shouldShowRequestPermissionRationale(MainActivity.this, Manifest.permission.RECEIVE_SMS)) {

            new AlertDialog.Builder(this)
                    .setTitle("درخواست مجوز")
                    .setMessage("برای عملکرد صحیح برنامه باید دسترسی به دریافت پیامکتایید شود")
                    .setPositiveButton("موافقم", new DialogInterface.OnClickListener() {
                        @Override
                        public void onClick(DialogInterface dialogInterface, int i) {

                            reqPermission();

                        }
                    })
                    .setNegativeButton("لغو", new DialogInterface.OnClickListener() {
                        @Override
                        public void onClick(DialogInterface dialogInterface, int i) {

                            dialogInterface.dismiss();

                        }
                    })
                    .create()
                    .show();

        } else {

            reqPermission();

        }

    }

    private void reqPermission() {

        ActivityCompat.requestPermissions(MainActivity.this, new String[] {Manifest.permission.RECEIVE_SMS}, SMS_REQUEST_CODE);

    }

    @Override
    public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults) {

        super.onRequestPermissionsResult(requestCode, permissions, grantResults);

        if (requestCode == SMS_REQUEST_CODE) {

            if (grantResults.length > 0 && grantResults[0] == PackageManager.PERMISSION_GRANTED) {

                Toast.makeText(this, "مجوز تایید شد", Toast.LENGTH_SHORT).show();

            } else {

                Toast.makeText(this, "مجوز رد شد", Toast.LENGTH_SHORT).show();

            }

        }

    }

}

یکی از دیوایس‌های امولاتور اندرویدی Genymotion را اجرا می‌کنم. یکی از امکانات کاربردی شبیه سازهای اندرویدی از جمله Genymotion و همچنین AVD (شبیه ساز داخلی اندروید استودیو) قابلیت ارسال پیامک به دستگاه و همچنین برقراری تماس است. بدون آنکه نیاز به اجرا و تست برنامه روی یک دستگاه واقعی داشته باشیم.
پروژه را روی شبیه ساز اجرا کرده و مجوز دسترسی به پیامک‌ها را برای برنامه تایید می‌کنم. سپس روی آیکون Phone منوی سمت راست دیوایس کلیک می‌کنم:

در کادر Phone یک شماره فرستنده و متن دلخواه وارد کرده و پیام را ارسال می‌کنم. بلافاصله پیغام Toast ای که در متد onReceive تعریف کرده بودم اجرا شد:

تا اینجای کار مطمئن شدیم برنامه ما می‌تواند به درستی رویدادهای مربوط به دریافت پیامک را شنود کند. در قدم بعد می‌خواهیم محتوای SMS دریافتی را به دست بیاوریم که شامل شماره ارسال کننده پیام و همچنین متن پیامک می‌باشد.
پیغام Toast داخل متد onReceive برودکست رسیور را حذف کرده و کد زیر را جایگزین آن می‌کنم:

if (intent.getAction().equals("android.provider.Telephony.SMS_RECEIVED")) {

    Bundle mBundle = intent.getExtras();
    SmsMessage[] msg;
    String smsFrom;

    if (mBundle != null) {
        try {
            Object[] mPdus = (Object[]) mBundle.get("pdus");
            msg = new SmsMessage[mPdus.length];

            for (int i = 0; i < mPdus.length; i++) {
                msg[i] = SmsMessage.createFromPdu((byte[]) mPdus[i]);
                smsFrom = msg[i].getOriginatingAddress();
                String smsBody = msg[i].getMessageBody();

                Toast.makeText(context, "شماره: " + smsFrom + " / پیام: " + smsBody, Toast.LENGTH_SHORT).show();
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

}

در ابتدا یک if تعریف شده که بررسی می‌کند کدها تنها در صورتی اجرا شوند که اینتنت اکشن دریافتی از نوع android.provider.Telephony.SMS_RECEIVED باشد. یعنی دقیقا همان اکشنی که قبلا در AndroidManifest.xml و در تگ receiver ثبت کردیم.
سپس یک نمونه از Bundle و SmsMessage و یک String ساخته شده. در ادامه ابتدا بررسی می‌شود آیا مقدار ذخیره شده در mBundle نال است یا نه؛ یعنی داده‌ای که مربوط به محتوای یک پیامک باشد در باندل ذخیره شده یا خیر.
یک نمونه از Object[] با نام دلخواه mPdus ایجاد شده که داده‌ها با فرمت PDU (مخفف Protocol Data Unit) در آن ذخیره می‌شود. با استفاده از PDU به ساختار محتوای پیام دریافتی دسترسی داریم.
سپس در حلقه for با استفاده از SmsMessage.createFromPdu() محتوای پیام دریافتی تفکیک می‌شود. همانطور که ملاحظه می‌کنید در دو خط بعد توسط getOriginatingAddress و getMessageBody به ترتیب به شماره ارسال کننده پیام و متن پیام دسترسی خواهیم داشت. کاربرد متدها از نحوه نامگذاری آنها هم مشخص است. عبارت Originating Address به معنی آدرس مبدا و Message Body به معنی بدنه یا متن پیام است.
در انتها، این دو آیتم در یک پیغام Toast قرار داده شده است.
کد کامل کلاس برودکست رسیور:

SMSBroadcastReceiver.java

package ir.android_studio.receivesms;

import android.content.BroadcastReceiver;
import android.content.Context;
import android.content.Intent;
import android.os.Bundle;
import android.telephony.SmsMessage;
import android.widget.Toast;

public class SMSBroadcastReceiver extends BroadcastReceiver {
    @Override
    public void onReceive(Context context, Intent intent) {

        // Toast.makeText(context, "یک پیامک دریافت شد", Toast.LENGTH_SHORT).show();

        if (intent.getAction().equals("android.provider.Telephony.SMS_RECEIVED")) {

            Bundle mBundle = intent.getExtras();
            SmsMessage[] msg;
            String smsFrom;

            if (mBundle != null) {
                try {
                    Object[] mPdus = (Object[]) mBundle.get("pdus");
                    msg = new SmsMessage[mPdus.length];

                    for (int i = 0; i < mPdus.length; i++) {
                        msg[i] = SmsMessage.createFromPdu((byte[]) mPdus[i]);
                        smsFrom = msg[i].getOriginatingAddress();
                        String smsBody = msg[i].getMessageBody();

                        Toast.makeText(context, "شماره: " + smsFrom + " / پیام: " + smsBody, Toast.LENGTH_SHORT).show();
                    }
                } catch (Exception e) {
                    e.printStackTrace();
                }
            }

        }

    }
}

پروژه را دوباره اجرا کرده و با استفاده از گزینه Phone یک پیام جدید ارسال می‌کنم. حالا شماره ارسال کننده و متن SMS هم در Toast نمایش داده می‌شود:

دریافت پیامک (SMS) توسط Cursor

همانطور که در ابتدای جلسه اشاره شد، با وجود کلاس SmsMessage استفاده از Cursor برای دریافت پیامک توجیهی نخواهد داشت اما لازم دانستم حداقل برای تمرین به این مورد هم اشاره کنم.
یک پروژه جدید بسازید و TextView پیش فرض اکتیویتی را به Button تبدیل کنید. سپس کد زیر را در رویداد onClickListener دکمه قرار دهید (از تعریف Runtime Permission فراموش نکنید).

Cursor cursor = getContentResolver().query(Uri.parse("content://sms"), null, null, null, null);

cursor.moveToFirst();

Toast.makeText(this, cursor.getString(12), Toast.LENGTH_SHORT).show();

بعد از اجرای پروژه و تایید مجوز دریافت SMS، مانند قبل یک پیامک ارسال کرده و سپس روی Button کلیک کنید. متن پیامک در قالب Toast نمایش داده خواهد شد. البته در این روش هم می‌توان شماره ارسال کننده پیامک را دریافت کرد که به آن نمی‌پردازم.

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

نوشته دریافت پیامک (SMS) در برنامه اندرویدی + سورس پروژه اولین بار در اندروید استودیو پدیدار شد.

کاربردهای ارسال پیامک از طریق اپلیکیشن

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

نحوه ارسال پیامک در اندروید

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

ارسال پیامک (SMS) از طریق Intent

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

public void contactMessage(View v) {
    Intent cnt_msg = new Intent();
    cnt_msg.setAction(Intent.ACTION_VIEW);
    cnt_msg.setData(Uri.parse("sms:+989158888888"));
    cnt_msg.putExtra("sms_body", "سلام. در خصوص اپلیکیشن شرکتتون یه پیشنهاد داشتم");
    startActivity(cnt_msg);
}

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

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

ارسال پیامک (SMS) از طریق کلاس SmsManager

بر خلاف روش قبل یعنی ارسال پیامک از طریق intent در این روش و با استفاده از کلاس SmsManager پیامک به طور مستقیم و درون خود برنامه به مقصد ارسال شده و کاربر دسترسی به محتوای پیامک نخواهد داشت. به عبارت دیگر، کاربر از فرایند ارسال پیامک آگاه نخواهد شد.
با استفاده از SmsManager می‌توان ۴ نوع پیام را ارسال کرد که لازم است کاربرد هرکدام را توضیح دهم:
sendTextMessage: همانطور که از نام این متد پیداست، برای ارسال پیامک (SMS) معمولی بکار می‌رود. یعنی ارسال پیامک متنی در قالب یک پیام و به مقصد از قبل تعیین شده. درست همان چیزی که در این جلسه نیاز داریم.
sendMultipartTextMessage: عملیات مشابه متد قبل را انجام می‌دهد با این تفاوت که می‌توان پیام را در قالب چند پیام جداگانه به مقصد ارسال کرد.
sendDataMessage: از این متد برای ارسال پیام داده محور و در یک پورت مشخص استفاده می‌شود.
sendMultimediaMessage: چنانچه قصد ارسال پیام مولتی مدیا یا همان MMS (مانند ارسال عکس) داشته باشیم باید از این متد استفاده کنیم.

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

ساخت پروژه اندرویدی ارسال پیامک

مطابق مبحث آموزش ساخت پروژه در اندروید استودیو یک پروژه اندرویدی با نام SendSMS می‌سازم. اکتیویتی را از نوع Empty Activity و زبان را Java انتخاب کردم.
در این پروژه قصد داریم با استفاده از کلاس SmsManager بصورت درون برنامه‌ای و بدون نیاز به برنامه مدیریت پیامک، یک پیام کوتاه به مقصدی مشخص ارسال کنیم. همچنین نحوه فعالسازی گزارش ارسال (sent) و گزارش تحویل (delivery) پیامک و در دسترس بودن یا نبودن سیم کارت جهت ارسال SMS را نیز بررسی خواهیم کرد.
در رابط کاربری این پروژه تنها به یک دکمه برای ارسال متن پیامک از پیش تعیین شده نیاز داریم. بنابراین در layout پیش فرض اکتیویتی پروژه کافیست TextView موجود در مرکز ویو گروپ ConstraintLayout را به Button تبدیل کرده و یک id به آن اختصاص دهم:

activity_main.xml

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout 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"
    tools:context=".MainActivity">

    <Button
        android:id="@+id/sms_btn"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="ارسال پیامک"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toTopOf="parent" />

</androidx.constraintlayout.widget.ConstraintLayout>

اگر با این layout آشنایی ندارید آموزش کار با ConstraintLayout را مطالعه کنید. حالا رویداد مربوط به دکمه را در اکتیویتی تعریف می‌کنم:

MainActivity.java

package ir.android_studio.sendsms;

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

public class MainActivity extends AppCompatActivity {

    Button sendBtn;

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

        sendBtn = findViewById(R.id.sms_btn);

        sendBtn.setOnClickListener(view -> {

        });

    }
}

نکته: در نسخه‌های اخیر اندروید استودیو، هنگام اضافه کردن متد setOnClickListener پیشنهادی مبنی بر جایگزینی View.OnClickListener با lambda داده می‌شود که با زدن alt+Enter یا کلیک روی آیکون لامپ، جایگزینی انجام می‌شود. تفاوت در کوتاه شدن کدهاست.

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

sendBtn.setOnClickListener(view -> {

});

تعریف مجوز ارسال پیامک

در قدم اول لازم است مجوز یا Permission ارسال پیامک (SMS) را در برنامه تعریف کنیم. ابتدا پرمیشن SEND_SMS را در مانیفست پروژه تعریف می‌کنم:

<uses-permission android:name="android.permission.SEND_SMS"/>

AndroidManifest.xml

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

    <uses-permission android:name="android.permission.SEND_SMS"/>

    <application
        android:allowBackup="true"
        android:icon="@mipmap/ic_launcher"
        android:label="@string/app_name"
        android:roundIcon="@mipmap/ic_launcher_round"
        android:supportsRtl="true"
        android:theme="@style/Theme.SendSMS">
        <activity android:name=".MainActivity">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />

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

</manifest>

همچنین مطابق جلسه آموزش پیاده سازی Runtime Permission برای دریافت مجوز در دستگاه‌های اندرویدی ۶ و به بالا کدهای لازم را به پروژه اضافه می‌کنم:

MainActivity.java

package ir.android_studio.sendsms;

import androidx.annotation.NonNull;
import androidx.appcompat.app.AlertDialog;
import androidx.appcompat.app.AppCompatActivity;
import androidx.core.app.ActivityCompat;
import androidx.core.content.ContextCompat;

import android.Manifest;
import android.content.DialogInterface;
import android.content.pm.PackageManager;
import android.os.Bundle;
import android.widget.Button;
import android.widget.Toast;

public class MainActivity extends AppCompatActivity {

    Button sendBtn;
    private final int SMS_REQUEST_CODE = 100;

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

        sendBtn = findViewById(R.id.sms_btn);

        sendBtn.setOnClickListener(view -> {

            if (ContextCompat.checkSelfPermission(MainActivity.this, Manifest.permission.SEND_SMS) != PackageManager.PERMISSION_GRANTED) {
                
                requestSendSMSpermission();
                
            } else {
                
                sendMessage();
                
            }

        });

    }

    private void requestSendSMSpermission() {

        if (ActivityCompat.shouldShowRequestPermissionRationale(MainActivity.this, Manifest.permission.SEND_SMS)) {

            new AlertDialog.Builder(this)
                    .setTitle("درخواست مجوز")
                    .setMessage("برای عملکرد صحیح برنامه باید دسترسی به ارسال پیامک تایید شود")
                    .setPositiveButton("موافقم", new DialogInterface.OnClickListener() {
                        @Override
                        public void onClick(DialogInterface dialogInterface, int i) {

                            reqPermission();

                        }
                    })
                    .setNegativeButton("لغو", new DialogInterface.OnClickListener() {
                        @Override
                        public void onClick(DialogInterface dialogInterface, int i) {

                            dialogInterface.dismiss();

                        }
                    })
                    .create()
                    .show();

        } else {

            reqPermission();

        }

    }

    private void reqPermission() {

        ActivityCompat.requestPermissions(MainActivity.this, new String[] {Manifest.permission.SEND_SMS}, SMS_REQUEST_CODE);

    }

    @Override
    public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults) {

        if (requestCode == SMS_REQUEST_CODE) {

            if (grantResults.length > 0 && grantResults[0] == PackageManager.PERMISSION_GRANTED) {
                
                sendMessage();
                
            } else {
                
                Toast.makeText(this, "مجوز رد شد", Toast.LENGTH_SHORT).show();
                
            }

        }

    }
    
}

پیاده سازی کلاس SmsManager

با اضافه شدن کدهای فوق، پس از لمس دکمه “ارسال پیامک” چنانچه کاربر مجوز ارسال SMS را به برنامه اعطا کند، تابع sendMessage فراخوانی خواهد شد. تابعی با همین نام درون اکتیویتی و بعد از متد onCreate اضافه کرده و کدهای مربوط به ارسال پیامک را درون آن می‌نویسم:

private void sendMessage() {

    try {
        
        SmsManager smsManager = SmsManager.getDefault();
        smsManager.sendTextMessage("+989158888888", null, "تست ارسال پیامک", null, null);

        Toast.makeText(MainActivity.this, " پیامک ارسال شد", Toast.LENGTH_SHORT).show();
        
    } catch (Exception e) {
        
        Toast.makeText(MainActivity.this, " پیامک ارسال نشد", Toast.LENGTH_SHORT).show();
        
    }

}

کدهای مربوط به ارسال پیامک را درون یک try catch قرار داده‌ام تا چنانچه به هر دلیلی فرایند ارسال SMS انجام نشد، برنامه کرش نکند.
در کد فوق ابتدا یک نمونه (شیء) از کلاس SmsManager با نام دلخواه smsManager ایجاد شده که برای مقدار دهی آن، متد getDefault فراخوانی شده است. این متد شناسه سیم کارت پیش فرض دستگاه اندرویدی را دریافت می‌کند که برای ارسال پیامک ضروری است. توصیه می‌کنم توضیحات تکمیلی اینجا و اینجا را در خصوص دستگاه‌های دو سیم کارت مطالعه کنید.
در خط دوم، متد sendTextMessage تعریف شده که ۴ پارامتر ورودی می‌پذیرد. در تصویر زیر جنس هر ورودی قابل تشخیص است:

destinationAddress: پارامتر نخست از جنس String بوده که همان شماره گیرنده پیام می‌باشد.
scAddress: پارامتر دوم مربوط به آدرس یا شماره‌ی Service Center پیامک اپراتوری است که کاربر از سیم کارت آن استفاده می‌کند. به طور معمول این شماره توسط کلاینت تعیین نمی‌شود و به عهده‌ی خود اپراتور است. بنابراین مقدار null را وارد می‌کنیم.
text: واضح است که این پارامتر، محتوای پیام را شامل می‌شود.
sentIntent و deliveryIntent: به ترتیب برای دریافت گزارش ارسال و گزارش تحویل پیامک استفاده می‌شود که در این مرحله به جهت درک بهتر عملکرد اصلی کلاس، برای هردو مقدار null درنظر گرفتم. بنابراین در این مرحله به نتیجه‌ی ارسال و یا تحویل پیامک به مقصد دسترسی نخواهیم داشت.
نگران نباشید! به این دو مورد هم در ادامه جلسه می‌پردازیم.
در همین مرحله پروژه را اجرا می‌کنم تا عملکرد کلاس SmsManager را بررسی کنیم.

با توجه به اینکه یک دیوایس با Android 10 را روی شبیه ساز (امولاتور) اندرویدی اجرا کرده‌ام، با کلیک روی دکمه ارسال پیامک ابتدا باید مجوز ارسال پیامک را تایید کنم.
با تایید مجوز، پیغام “پیامک ارسال شد” روی صفحه ظاهر شد که نشان می‌دهد عملکرد برنامه تا اینجای کار درست بوده:

پیامک ارسال شده در برنامه مدیریت SMS پیش فرض دستگاه نیز قابل مشاهده است:

دریافت گزارش ارسال و گزارش تحویل پیامک

در قسمت قبل صرفا یک SMS توسط کلاس SmsManager ارسال کردیم و دسترسی به گزارش ارسال و تحویل پیامک نداشتیم و برای هردو پارامتر sentIntent و deliveryIntent مقدار null داده بودیم.
اما در این قسمت و در ادامه‌ی آموزش ارسال پیامک (SMS) در برنامه نویسی اندروید با استفاده از BroadcastReceiver و PendingIntent رویدادهای مربوط به وضعیت ارسال و تحویل پیامک را شنود کرده و پیغام مربوط آن را چاپ می‌کنیم.
ابتدا در بدنه اصلی کلاس اکتیویتی دو متغیر از جنس String با نام و مقدار دلخواه تعریف می‌کنم. از این دو متغیر برای برقراری ارتباط بین BroadcastReceiver و PendingIntent مربوط به یکدیگر استفاده خواهیم کرد:

String SMS_SENT = "SMS_SENT";
String SMS_DELIVERED = "SMS_DELIVERED";

سپس مطابق جلسه آموزش شنود رویدادها در اندروید توسط BroadcastReceiver دو برودکست را درون متد sendMessage داخل بلاک try و قبل از smsManager، رجیستر می‌کنم:

//Broadcast for Sent SMS
registerReceiver(new BroadcastReceiver() {
    @Override
    public void onReceive(Context context, Intent intent) {

        String state = "";
        switch (getResultCode()) {
            case Activity.RESULT_OK:
                state = "پیامک ارسال شد";
                break;
            case SmsManager.RESULT_ERROR_GENERIC_FAILURE:
                state = "یک خطای عمومی رخ داد";
                break;
            case SmsManager.RESULT_ERROR_NO_SERVICE:
                state = "اپراتور در دسترس نیست";
                break;
            case SmsManager.RESULT_ERROR_NULL_PDU:
                state = " پروتکل PDU در دسترس نیست";
                break;
            case SmsManager.RESULT_ERROR_RADIO_OFF:
                state = "سیم کارت در دسترس نیست";
                break;
        }
        Toast.makeText(context, state, Toast.LENGTH_SHORT).show();
    }
}, new IntentFilter(SMS_SENT));

//Broadcast for Delivered SMS
registerReceiver(new BroadcastReceiver() {
    @Override
    public void onReceive(Context context, Intent intent) {
        String state = "";
        switch (getResultCode()) {
            case Activity.RESULT_OK:
                state = "پیامک تحویل داده شد";
                break;
            case Activity.RESULT_CANCELED:
                state = "پیامک تحویل داده نشد";
                break;
        }
        Toast.makeText(context, state, Toast.LENGTH_SHORT).show();
    }
}, new IntentFilter(SMS_DELIVERED));

برودکست اول برای شنود وضعیت ارسال پیامک استفاده خواهد شد. چنانچه پیامک با موفقیت به سرویس دهنده (اپراتور) ارسال شود، پیغام “پیامک ارسال شد” و در غیر اینصورت سایر پیغام‌های مناسب وضعیت رخ داده نمایش داده خواهد شد.
برای حالت عدم ارسال پیامک، ۴ حالت مختلف تعریف شده که با توجه به وضعیت دریافتی از SmsManager، نوع خطا را به کاربر اعلام می‌کند. خطای دریافتی می‌تواند یک خطای عمومی بوده یا مربوط به در دسترس نبودن اپراتور، در دسترس نبودن سیم کارت و یا پروتکل PDU (Protocol Data Unit) باشد.
برودکست دوم نیز برای شنود وضعیت تحویل یا عدم تحویل SMS به گیرنده بکار می‌رود.
بعد از برودکست‌ها دو PendingIntent به صورت زیر تعریف می‌کنم:

PendingIntent sentSMS = PendingIntent.getBroadcast(this, 0, new Intent(SMS_SENT), 0);
PendingIntent deliverSMS = PendingIntent.getBroadcast(this, 0, new Intent(SMS_DELIVERED), 0);

قبلا در جلسه آموزش ساخت نوتیفیکیشن‌های حرفه‌ای در اندروید با کاربرد PendingIntent ها آشنا شدیم. با استفاده از متد getBroadcast، برودکست موردنظر در PendingIntent تعریف می‌شود.
پارامتر سوم getBroadcast از جنس اینتنت بوده که شامل اکشن‌های SMS_SENT و SMS_DELIVERED می‌باشد که قبلا در برودکست‌ها تعیین کرده بودیم. همانطور که از نحوه نامگذاری PendingIntent ها پیداست، مورد اول برای اجرای برودکست ارسال پیامک و مورد دوم برای اجرای برودکست تحویل پیامک استفاده خواهد شد.
در انتها لازم است این دو PendingIntent در smsManager جایگزین مقدارهای null شوند:

smsManager.sendTextMessage("+989158888888", null, "تست ارسال پیامک", sentSMS, deliverSMS);

بنابراین با ارسال پیامک توسط SmsManager در آینده و هر زمانی که گزارش مربوط به وضعیت ارسال و همچنین تحویل پیامک توسط سیستم عامل منتشر شود، توسط BroadcastReceiver ها دریافت شده و پیغام مناسب روی صفحه ظاهر خواهد شد.
در نهایت، متن پیغام Toast که بعد از smsManager قرار گرفته را از “پیامک ارسال شد” به “ارسال پیامک آغاز شد” تغییر می‌دهم تا از پیغامی که در برودکست ارسال پیامک تعریف شده قابل تشخیص باشد.
مجدد پروژه را اجرا کرده و روی دکمه ارسال پیامک کلیک می‌کنم:

مشاهده می‌کنید گزارش مربوط به ارسال و تحویل پیامک توسط برنامه دریافت و پیغام آن نمایش داده شد.
کد نهایی اکتیویتی تا اینجای کار:

MainActivity.java

package ir.android_studio.sendsms;

import androidx.annotation.NonNull;
import androidx.appcompat.app.AlertDialog;
import androidx.appcompat.app.AppCompatActivity;
import androidx.core.app.ActivityCompat;
import androidx.core.content.ContextCompat;
import android.Manifest;
import android.app.Activity;
import android.app.PendingIntent;
import android.content.BroadcastReceiver;
import android.content.Context;
import android.content.DialogInterface;
import android.content.Intent;
import android.content.IntentFilter;
import android.content.pm.PackageManager;
import android.os.Bundle;
import android.telephony.SmsManager;
import android.widget.Button;
import android.widget.Toast;

public class MainActivity extends AppCompatActivity {

    Button sendBtn;
    private final int SMS_REQUEST_CODE = 100;
    String SMS_SENT = "SMS_SENT";
    String SMS_DELIVERED = "SMS_DELIVERED";

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

        sendBtn = findViewById(R.id.sms_btn);

        sendBtn.setOnClickListener(view -> {

            if (ContextCompat.checkSelfPermission(MainActivity.this, Manifest.permission.SEND_SMS) != PackageManager.PERMISSION_GRANTED) {

                requestSendSMSpermission();

            } else {

                sendMessage();

            }

        });

    }

    private void sendMessage() {

        try {

            //Broadcast for Sent SMS
            registerReceiver(new BroadcastReceiver() {
                @Override
                public void onReceive(Context context, Intent intent) {

                    String state = "";
                    switch (getResultCode()) {
                        case Activity.RESULT_OK:
                            state = "پیامک ارسال شد";
                            break;
                        case SmsManager.RESULT_ERROR_GENERIC_FAILURE:
                            state = "یک خطای عمومی رخ داد";
                            break;
                        case SmsManager.RESULT_ERROR_NO_SERVICE:
                            state = "اپراتور در دسترس نیست";
                            break;
                        case SmsManager.RESULT_ERROR_NULL_PDU:
                            state = " پروتکل PDU در دسترس نیست";
                            break;
                        case SmsManager.RESULT_ERROR_RADIO_OFF:
                            state = "سیم کارت در دسترس نیست";
                            break;
                    }
                    Toast.makeText(context, state, Toast.LENGTH_SHORT).show();
                }
            }, new IntentFilter(SMS_SENT));

            //Broadcast for Delivered SMS
            registerReceiver(new BroadcastReceiver() {
                @Override
                public void onReceive(Context context, Intent intent) {
                    String state = "";
                    switch (getResultCode()) {
                        case Activity.RESULT_OK:
                            state = "پیامک تحویل داده شد";
                            break;
                        case Activity.RESULT_CANCELED:
                            state = "پیامک تحویل داده نشد";
                            break;
                    }
                    Toast.makeText(context, state, Toast.LENGTH_SHORT).show();
                }
            }, new IntentFilter(SMS_DELIVERED));

            PendingIntent sentSMS = PendingIntent.getBroadcast(this, 0, new Intent(SMS_SENT), 0);
            PendingIntent deliverSMS = PendingIntent.getBroadcast(this, 0, new Intent(SMS_DELIVERED), 0);

            SmsManager smsManager = SmsManager.getDefault();
            smsManager.sendTextMessage("+989158888888", null, " تست ارسال پیامک", sentSMS, deliverSMS);

            Toast.makeText(MainActivity.this, " ارسال پیامک آغاز شد", Toast.LENGTH_SHORT).show();

        } catch (Exception e) {

            Toast.makeText(MainActivity.this, " پیامک ارسال نشد", Toast.LENGTH_SHORT).show();

        }

    }

    private void requestSendSMSpermission() {

        if (ActivityCompat.shouldShowRequestPermissionRationale(MainActivity.this, Manifest.permission.SEND_SMS)) {

            new AlertDialog.Builder(this)
                    .setTitle("درخواست مجوز")
                    .setMessage("برای عملکرد صحیح برنامه باید دسترسی به ارسال پیامک تایید شود")
                    .setPositiveButton("موافقم", new DialogInterface.OnClickListener() {
                        @Override
                        public void onClick(DialogInterface dialogInterface, int i) {

                            reqPermission();

                        }
                    })
                    .setNegativeButton("لغو", new DialogInterface.OnClickListener() {
                        @Override
                        public void onClick(DialogInterface dialogInterface, int i) {

                            dialogInterface.dismiss();

                        }
                    })
                    .create()
                    .show();

        } else {

            reqPermission();

        }

    }

    private void reqPermission() {

        ActivityCompat.requestPermissions(MainActivity.this, new String[] {Manifest.permission.SEND_SMS}, SMS_REQUEST_CODE);

    }

    @Override
    public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults) {

        if (requestCode == SMS_REQUEST_CODE) {

            if (grantResults.length > 0 && grantResults[0] == PackageManager.PERMISSION_GRANTED) {

                sendMessage();

            } else {

                Toast.makeText(this, " مجوز رد شد", Toast.LENGTH_SHORT).show();

            }

        }

    }

}

بررسی وضعیت سیم کارت قبل از ارسال پیامک

در قسمت قبل پس از ارسال پیامک و توسط کلاس SmsManager وضعیت سیم کارت بررسی می‌شد و در صورت عدم امکان ارسال SMS علت عدم ارسال توسط BroadcastReceiver مشخص می‌شد.
اما با استفاده از کلاس TelephonyManager و متد getSimState می‌توانیم قبل از اقدام به ارسال SMS هم وضعیت سیم کارت را از سیستم عامل دریافت کرده و بر اساس آن عملیاتی انجام داد. برای مثال تا زمانی که سیم کارت در دسترس نباشد، دکمه ارسال پیامک در حالت غیر فعال (Disable) قرار گیرد و یا سایر روش‌های آگاه سازی کاربر به در دسترس نبودن سیم کارت که موضوع این جلسه نیست.
البته کاربرد getSimState محدود به قبل از ارسال پیامک نمی‌شود. برنامه ما ممکن است به هر دلیلی نیاز به فعال بودن سیم کارت داشته باشد؛ مانند دریافت رمز یکبار مصرف. بنابراین می‌توانیم کاربر را از وضعیت سیم کارت دستگاه مطلع کنیم.
یک متد با نام دلخواه simState درون اکتیویتی تعریف و به صورت زیر تکمیل می‌کنم:

public void simState() {
    TelephonyManager telephonyManager = (TelephonyManager) getSystemService(Context.TELEPHONY_SERVICE);
    int SIM_STATE = telephonyManager.getSimState();

    if (SIM_STATE == TelephonyManager.SIM_STATE_READY) {
        Toast.makeText(this, "سیم کارت در دسترس است", Toast.LENGTH_SHORT).show();
    }
    else {
        String state = "";
        switch (SIM_STATE) {
            case TelephonyManager.SIM_STATE_ABSENT:
                state = "Sim absent";
                break;
            case TelephonyManager.SIM_STATE_NETWORK_LOCKED:
                state = "Network locked";
                break;
            case TelephonyManager.SIM_STATE_PIN_REQUIRED:
                state = "Pin required";
                break;
            case TelephonyManager.SIM_STATE_PUK_REQUIRED:
                state = "PUK required";
                break;
            case TelephonyManager.SIM_STATE_UNKNOWN:
                state = "Unknown";
                break;
        }
        Toast.makeText(this, state, Toast.LENGTH_SHORT).show();
    }
}

در کد فوق با استفاده از متد getSimState وضعیت سیم کارت بررسی می‌شود. چنانچه سیم کارت در دسترس باشد حالت SIM_STATE_READY برگردانده می‌شود. در غیر اینصورت یکی از ۵ حالت تعریف شده در قسمت دوم شرط برگردانده شده و پیغام مربوط به آن حالت در Toast نمایش داده خواهد شد.
برای اجرای متد simState() کافیست آنرا در متد onCreate() اکتیویتی فراخوانی کنیم.
پروژه را یکبار در حالتی که سیم کارت درون شیار دستگاه قرار دارد و بار دوم در حالتی که سیم کارت موجود نیست اجرا می‌کنم:

MainActivity.java

package ir.android_studio.sendsms;

import androidx.annotation.NonNull;
import androidx.appcompat.app.AlertDialog;
import androidx.appcompat.app.AppCompatActivity;
import androidx.core.app.ActivityCompat;
import androidx.core.content.ContextCompat;
import android.Manifest;
import android.app.Activity;
import android.app.PendingIntent;
import android.content.BroadcastReceiver;
import android.content.Context;
import android.content.DialogInterface;
import android.content.Intent;
import android.content.IntentFilter;
import android.content.pm.PackageManager;
import android.os.Bundle;
import android.telephony.SmsManager;
import android.telephony.TelephonyManager;
import android.widget.Button;
import android.widget.Toast;

public class MainActivity extends AppCompatActivity {

    Button sendBtn;
    private final int SMS_REQUEST_CODE = 100;
    String SMS_SENT = "SMS_SENT";
    String SMS_DELIVERED = "SMS_DELIVERED";

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

	simState();

        sendBtn = findViewById(R.id.sms_btn);

        sendBtn.setOnClickListener(view -> {

            if (ContextCompat.checkSelfPermission(MainActivity.this, Manifest.permission.SEND_SMS) != PackageManager.PERMISSION_GRANTED) {

                requestSendSMSpermission();

            } else {

                sendMessage();

            }

        });

    }

    private void sendMessage() {

        try {

            //Broadcast for Sent SMS
            registerReceiver(new BroadcastReceiver() {
                @Override
                public void onReceive(Context context, Intent intent) {

                    String state = "";
                    switch (getResultCode()) {
                        case Activity.RESULT_OK:
                            state = "پیامک ارسال شد";
                            break;
                        case SmsManager.RESULT_ERROR_GENERIC_FAILURE:
                            state = "یک خطای عمومی رخ داد";
                            break;
                        case SmsManager.RESULT_ERROR_NO_SERVICE:
                            state = "اپراتور در دسترس نیست";
                            break;
                        case SmsManager.RESULT_ERROR_NULL_PDU:
                            state = " پروتکل PDU در دسترس نیست";
                            break;
                        case SmsManager.RESULT_ERROR_RADIO_OFF:
                            state = "سیم کارت در دسترس نیست";
                            break;
                    }
                    Toast.makeText(context, state, Toast.LENGTH_SHORT).show();
                }
            }, new IntentFilter(SMS_SENT));

            //Broadcast for Delivered SMS
            registerReceiver(new BroadcastReceiver() {
                @Override
                public void onReceive(Context context, Intent intent) {
                    String state = "";
                    switch (getResultCode()) {
                        case Activity.RESULT_OK:
                            state = "پیامک تحویل داده شد";
                            break;
                        case Activity.RESULT_CANCELED:
                            state = "پیامک تحویل داده نشد";
                            break;
                    }
                    Toast.makeText(context, state, Toast.LENGTH_SHORT).show();
                }
            }, new IntentFilter(SMS_DELIVERED));

            PendingIntent sentSMS = PendingIntent.getBroadcast(this, 0, new Intent(SMS_SENT), 0);
            PendingIntent deliverSMS = PendingIntent.getBroadcast(this, 0, new Intent(SMS_DELIVERED), 0);

            SmsManager smsManager = SmsManager.getDefault();
            smsManager.sendTextMessage("+989158888888", null, " تست ارسال پیامک", sentSMS, deliverSMS);

            Toast.makeText(MainActivity.this, " ارسال پیامک آغاز شد", Toast.LENGTH_SHORT).show();

        } catch (Exception e) {

            Toast.makeText(MainActivity.this, " پیامک ارسال نشد", Toast.LENGTH_SHORT).show();

        }

    }

    private void requestSendSMSpermission() {

        if (ActivityCompat.shouldShowRequestPermissionRationale(MainActivity.this, Manifest.permission.SEND_SMS)) {

            new AlertDialog.Builder(this)
                    .setTitle("درخواست مجوز")
                    .setMessage("برای عملکرد صحیح برنامه باید دسترسی به ارسال پیامک تایید شود")
                    .setPositiveButton("موافقم", new DialogInterface.OnClickListener() {
                        @Override
                        public void onClick(DialogInterface dialogInterface, int i) {

                            reqPermission();

                        }
                    })
                    .setNegativeButton("لغو", new DialogInterface.OnClickListener() {
                        @Override
                        public void onClick(DialogInterface dialogInterface, int i) {

                            dialogInterface.dismiss();

                        }
                    })
                    .create()
                    .show();

        } else {

            reqPermission();

        }

    }

    private void reqPermission() {

        ActivityCompat.requestPermissions(MainActivity.this, new String[] {Manifest.permission.SEND_SMS}, SMS_REQUEST_CODE);

    }

    @Override
    public void onRequestPermissionsResult(int requestCode, @NonNull String[] permissions, @NonNull int[] grantResults) {

        if (requestCode == SMS_REQUEST_CODE) {

            if (grantResults.length > 0 && grantResults[0] == PackageManager.PERMISSION_GRANTED) {

                sendMessage();

            } else {

                Toast.makeText(this, " مجوز رد شد", Toast.LENGTH_SHORT).show();

            }

        }

    }

    public void simState() {
    TelephonyManager telephonyManager = (TelephonyManager) getSystemService(Context.TELEPHONY_SERVICE);
    int SIM_STATE = telephonyManager.getSimState();

    if (SIM_STATE == TelephonyManager.SIM_STATE_READY) {
        Toast.makeText(this, "سیم کارت در دسترس است", Toast.LENGTH_SHORT).show();
    }
    else {
        String state = "";
        switch (SIM_STATE) {
            case TelephonyManager.SIM_STATE_ABSENT:
                state = "Sim absent";
                break;
            case TelephonyManager.SIM_STATE_NETWORK_LOCKED:
                state = "Network locked";
                break;
            case TelephonyManager.SIM_STATE_PIN_REQUIRED:
                state = "Pin required";
                break;
            case TelephonyManager.SIM_STATE_PUK_REQUIRED:
                state = "PUK required";
                break;
            case TelephonyManager.SIM_STATE_UNKNOWN:
                state = "Unknown";
                break;

            }
        	Toast.makeText(this, state, Toast.LENGTH_SHORT).show();
        }
    }

}

در این جلسه ارسال پیامک (SMS) در برنامه نویسی اندروید را به همراه نحوه‌ی دریافت گزارش ارسال و تحویل و همچنین وضعیت سیم کارت دیوایس اندرویدی بررسی کردیم. امیدوارم مفید واقع شود.
موفق و پیروز باشید.

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

https://developer.android.com/reference/android/telephony/SmsManager
https://developer.android.com/reference/android/app/PendingIntent

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

نوشته ارسال پیامک (SMS) در برنامه اندرویدی + سورس پروژه اولین بار در اندروید استودیو پدیدار شد.

این جلسه در قالب PDF و در ۱۰۷ صفحه تهیه شده که در ادامه چند صفحه‌ ابتدایی را مشاهده می‌کنید:

ConstraintLayout چیست؟

به نام خدا. ConstraintLayout برای اولین بار در کنفرانس Google I/O در سال ۲۰۱۶ معرفی شد. اصلی ترین هدف گوگل از معرفی این Layout جدید، امکان طراحی لایه‌های پیچیده و در عین حال flat (تخت) بود؛ بر خلاف Layout های قبلی که برای طراحی یک صفحه ناگزیر به استفاده از لایه‌های تو در تو و سلسله مراتبی بودیم.

این یعنی دیگر لازم نیست چندین لایه RelativeLayout و LinearLayout و… درون یکدیگر و به صورت تو در تو تعریف شود تا بتوان یک صفحه چند قسمتی را ساخت. بنابراین علاوه بر سادگی پیاده سازی این لایه و کاهش حجم نهایی کدهای آن، در طراحی صفحات با ConstraintLayout کارایی و performance اکتیویتی بهبود یافته و می‌تواند در افزایش سرعت نمایش UI روی دستگاه کاربر تاثیر مثبت بگذارد.
ConstraintLayout از اندروید استودیو ۲٫۲ اضافه شد و نسخه ابتدایی آن Beta 1 نام داشت. در طی این چند سال مرتبا اصلاحاتی روی آن انجام و همچنین قابلیت‌های جدیدی نیز اضافه شده است. خبر خوب اینکه این لایه از API 9 به بعد پشتیبانی می‌شود بنابراین مطمئن خواهیم بود تمامی دستگاه‌های اندرویدی که در حال حاضر در اختیار افراد هست به خوبی می‌توانند صفحاتی که با این layout طراحی شده‌اند را نمایش دهند.
در ConstraintLayout می‌توانیم وضعیت قرارگیری تمامی view/widget ها را نسبت به یکدیگر و یا parent شان تعیین کنیم. برای مثال می‌توانیم یک TextView را به نحوی در زیر یک ImageView متصل کنیم که در جهت افقی، متن همواره در مرکز تصویر قرار گیرد. یا اینکه یک یا چند view بر اساس سایز صفحه نمایش دستگاه، چه از جهت افقی و چه عمودی همواره در مرکز قرار گرفته و علاوه بر آن، فاصله آنها از یکدیگر نیز درصدی ثابت باشد.
این یعنی یک انعطاف پذیری بسیار بالا که تا حدود زیادی مشابه طراحی صفحات واکنشگرا یا Responsive در صفحات وب است.
فکر می‌کنم هرچه اینجا بیشتر توضیح بدهم بیشتر هم شما را گیج می‌کنم! بنابراین بهتر است سراغ محیط توسعه اندروید استودیو رفته و امکانات این لایه قدرتمند را در عمل بررسی کنیم.
توجه داشته باشید در نسخه‌های ابتدایی اندروید استودیو که ConstraintLayout اضافه شده بود می‌بایست ابزار آن به صورت جداگانه در SDK و در زیرمجموعه Support Repository دریافت و نصب می‌شد اما در نسخه‌های اخیر، این گزینه از لیست SDK Tools حذف شده و با سایر ابزار اصلی توسعه اندروید ادغام شده است.
قبل از هرچیز توجه داشته باشید در برخورد اول قطعا کار با این layout مقداری گیج کننده خواهد بود بنابراین لازم است بارها و بارها تمرین کرده و خروجی کار را مقایسه کنید تا کاربرد هر قابلیت را بتوانید به درستی درک نمائید.

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

قبل از هرچیز ابتدا طبق مبحث آموزش ساخت پروژه در اندروید استودیو یک پروژه اندرویدی با نام ConstraintLayout می‌سازم. اکتیویتی را از نوع Empty Activity و زبان را Java انتخاب کردم.
کتابخانه این layout به صورت پیش فرض در بلاک dependencies فایل build.gradle(app) پروژه اندرویدی قرار دارد:

dependencies {
    implementation 'androidx.constraintlayout:constraintlayout:2.0.4'
}

در زمان نگارش این آموزش، نسخه ۲٫۰٫۴ جدیدترین نسخه از این ViewGroup است.
Layout پیش فرض اکتیویتی پروژه از نوع ConstraintLayout بوده که در قسمت Component tree قابل مشاهده است:

محیط پیش نمایش در دو حالت Design و Blueprint قابل نمایش است که به منظور خلوت بودن صفحه در حین آموزش تنها از حالت Design استفاده می‌کنم.

خطوط اتصال و گره‌ها در ConstraintLayout

از ساده ترین مثال شروع می‌کنم. ملاحظه می‌کنید یک TextView به طور پیش فرض در مرکز صفحه پیش نمایش با عنوان Hello World! قرار گرفته. موس را روی TextView قرار می‌دهم:

این TextView توسط ۴ خط اتصال به ۴ لبه‌ی صفحه متصل شده است. حالا روی TextView کلیک می‌کنم:

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

activity_main.xml

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout 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"
    tools:context=".MainActivity">

    <TextView
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="Hello World!"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintLeft_toLeftOf="parent"
        app:layout_constraintRight_toRightOf="parent"
        app:layout_constraintTop_toTopOf="parent" />

</androidx.constraintlayout.widget.ConstraintLayout>

ملاحظه می‌کنید یک TextView با تعدادی ویژگی درون layout از جنس ConstraintLayout قرار گرفته است. به عبارتی این layout والد یا parent ویجت TextView است.

app:layout_constraintBottom_toBottomOf="parent"
app:layout_constraintLeft_toLeftOf="parent"
app:layout_constraintRight_toRightOf="parent"
app:layout_constraintTop_toTopOf="parent"

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

app:layout_constraintBottom_toBottomOf="parent"

اگر به نحوه نامگذاری هر کدام دقت کنید کاربرد آن را متوجه خواهید شد.
Bottom to Bottom of parent یعنی پایینِ TextView به پایینِ parent متصل شود. و به همین ترتیب برای ۳ مورد دیگر. نتیجه این می‌شود که ویجت از بالا و پایین به یک اندازه و همچنین از چپ و راست هم به یک اندازه فاصله گرفته بنابراین در مرکز صفحه قرار می‌گیرد.
با توجه به اینکه در اینجا برای تعیین فاصله از واحدهای اندازه گیری استفاده نشده لذا یک رابط کاربری ساده و انعطاف پذیر داریم که در هر صفحه نمایشی اجرا شود اعم از کوچک و بزرگ یا افقی و عمودی، همواره این TextView در مرکز صفحه قرار خواهد گرفت.
اگر یکی از این خطوط حذف شود چه اتفاقی خواهد افتاد؟ می‌خواهم خط بالا را حذف کنم. برای اینکار هم می‌توان در حالت کد، ویژگی layout_constraintTop_toTopOf را از تکست ویو حذف کرد هم اینکه در حالت دیزاین، خط بالا را انتخاب کرده و delete ‌کنیم. همچنین اگر روی هریک از خطوط راست کلیک کنیم گزینه‌های مختلفی نمایش داده می‌شود که یکی از آنها Delete است:

مشاهده می‌کنید با حذف خط اتصال بالا، TextView از جهت افقی در مرکز قرار دارد اما در جهت عمودی به پایین صفحه چسبیده است. برای در مرکز قرار گرفتن ویجت کافی است دوباره ویژگی layout_constraintTop_toTopOf با مقدار parent را در ویرایشگر کد اضافه کرده و یا در محیط ویژوال به وسیله عمل Drag & Drop دایره یا گره بالای ویجت را گرفته و روی لبه بالای صفحه رها کنم:

در نهایت مجدد توانستم ویجت را نسبت به بالا و پایین در مرکز قرار دهم.
برای مشاهده جزئیات بیشتر روی گزینه Attributes نوار سمت راست محیط دیزاین کلیک می‌کنم. سپس روی صفحه پیش نمایش یا Component tree ویجت TextView را انتخاب می‌کنم تا ویژگی‌های مرتبط با آن نمایش داده شود:

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

تعیین فاصله از چپ و پایین توسط Bias

در سمت چپ و پایین دو گزینه در کنار عدد مارجین قرار دارد که توسط آن و با حرکت دادن دایره روی خط، میزان فاصله از چهار جهت را می‌توان تغییر داد. این قابلیت Bias نام دارد. دقت داشته باشید در اینجا خبری از واحدهای px و dp نیست بلکه بر اساس درصد تعیین می‌شود. به صورت پیش فرض هردو Bias روی ۵۰ قرار دارد یعنی مرکز صفحه.
اگر بخاطر داشته باشید در کد مربوط به TextView ویژگی با نام Bias وجود نداشت. این یعنی مقدار پیش فرض Bias برای یک ویجت همین ۵۰% یا مقدار ۰٫۵ است و صرفا در صورتی این ویژگی به ویجت اضافه خواهد شد که مقداری غیر از ۵۰ برای آن درنظر بگیریم.
برای تمرین، ویجت روی صفحه یا همین گزینه پایین که مربوط به جهت افقی هست را مقداری به سمت چپ بکشید:

ملاحظه می‌کنید عدد Horizontal Bias به ۲۵ تغییر کرد و ویجت هم در جهت افق به اندازه ۲۵ درصد به سمت چپ نزدیکتر شد. حالا اگر کد ویجت را دوباره بررسی کنید خط زیر به آن اضافه شده:

app:layout_constraintHorizontal_bias="0.25"

در محیط ویژوال عدد از ۰ تا ۱۰۰ و در کد از ۰ تا ۱ تعیین می‌شود. یعنی ۲۵ درصد برای Bias افقی (Horizontal) برابر است با مقدار ۰٫۲۵ برای ویژگی آن در کدها.
صفحه پیش نمایش را در حالت افقی (Landscape) قرار می‌دهم:

باز هم ویجت در فاصله ۲۵ درصدی از سمت چپ صفحه قرار گرفته و انعطاف پذیری ConstraintLayout را ثابت می‌کند.

تعیین عرض و ارتفاع Widget یا View ها

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

در تصویر بالا مشاهده می‌کنید با بردن نشانگر بر روی یکی از فاصله‌های افقی عبارت Wrap Content نمایش داده می‌شود. یکبار روی یکی از آنها کلیک می‌کنم:

نماد فاصله‌های افقی از دو فلش به یک خط ممتد تغییر پیدا کرد و عبارت Fixed را نمایش می‌دهد. همچنین در قسمت Declared Attributes مقدار width از wrap_content به ۷۶dp برای من تغییر داده شد یعنی اندروید استودیو یک مقدار پیش فرض در واحد dp را درنظر گرفت. حالا من می‌توانم مقدار مدنظر خودم را بجای ۷۶ وارد کنم.
در مواقعی به این حالت نیاز داریم که بخواهیم برای یک ویجت عرض یا ارتفاع مشخص و ثابتی را درنظر بگیریم و نباید اندازه آن به صفحه نمایش یا حالت قرار گیری آن بستگی داشته باشد.
یک مرتبه دیگر روی نماد فاصله افقی کلیک می‌کنم:

اینبار نوع فاصله گذاری به Match Constraints تغییر پیدا کرد. این حالت همان match_parents در layout هایی مانند RelativeLayout است اما در ConstraintLayout برای اینکه یک ویجت تمام عرض یا ارتفاع در دسترس را اشغال کند بجای match_parent مقدار ۰dp باید داده شود که اندروید استودیو این تغییر را به صورت خودکار برای من انجام داد:

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

خب! حالا که تا حدودی با کلیت کار آشنا شدیم ادامه آموزش را در قالب چند مثال عملی طراحی صفحات با ConstraintLayout پیش می‌برم تا درک بهتری از امکانات آن داشته باشید.
از مسیر New > Layout Resource file یک layout جدید با نام layout_two.xml به پروژه اضافه می‌کنم. هر قسمت را در یک فایل جداگانه توضیح می‌دهم تا همه کدها در سورس پروژه ضمیمه شده را در اختیار داشته باشید.
یک ویجت Button را از پالت ابزار کشیده و در مرکز صفحه پیش نمایش قرار می‌دهم:

اینجا ظاهرا مشکلی نیست و پس از رها کردن، دکمه در مرکز صفحه باقی می‌ماند. حالا می‌خواهم پروژه را اجرا کنم تا خروجی کار را روی دیوایس اندرویدی هم ببینیم. در MainActivity.java فایل layout_two را جایگزین activity_main می‌کنم تا هنگام اجرای پروژه روی دیوایس نمایش داده شود.

MainActivity.java

package ir.android_studio.constraintlayout;

import androidx.appcompat.app.AppCompatActivity;

import android.os.Bundle;

public class MainActivity extends AppCompatActivity {

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

پروژه را روی شبیه ساز Genymotion اجرا می‌کنم:

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

layout_two.xml

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout
    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">

    <Button
        android:id="@+id/button2"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="Button"
        tools:layout_editor_absoluteX="156dp"
        tools:layout_editor_absoluteY="342dp" />
</androidx.constraintlayout.widget.ConstraintLayout>

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

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

<Button
    android:id="@+id/button2"
    android:layout_width="wrap_content"
    android:layout_height="wrap_content"
    android:text="Button"
    app:layout_constraintEnd_toEndOf="parent"
    app:layout_constraintStart_toStartOf="parent"
    tools:layout_editor_absoluteY="342dp" />

در حال حاضر نحوه نمایش وضعیت constraint ویجت دکمه به اینصورت است:

در جهت بالا و پایین نماد + وجود دارد که به وضوح نشان می‌دهد در این گره‌ها اتصالی انجام نشده است. البته اگر اینجا روی + کلیک کنیم علاوه بر ایجاد خط اتصال، یک فاصله (margin) به مقداری که قبلا در layout_editor_absoluteY تعریف شده نیز اضافه خواهد شد.
به عبارت دیگر layout_marginTop جایگزین ویژگی layout_editor_absoluteY می‌شود:

بنابراین بهتر است ایجاد خط اتصال به همان شیوه Drag & Drop روی صفحه پیش نمایش انجام شود یا در صورت ایجاد آن از طریق دکمه + لازم است مقدار margin صفر و یا به عدد دلخواه اصلاح شود.
در نوار بالای پیش نمایش چندین گزینه وجود دارد که دو مورد را در اینجا و مابقی را بعدا توضیح خواهم داد.

حذف یکباره تمامی Constraint ها

گزینه Clear All Constraints همانطور که از نامش پیداست تمامی اتصالاتی که درون layout بر روی ویجت‌ها اعمال شده را به یکباره حذف می‌کند. این مورد مواقعی کاربرد دارد که تعدادی تغییرات در صفحه انجام داده‌ایم و لازم است همگی اصلاح شوند. با استفاده از این گزینه همه تغییرات قبلی حذف شده و لازم نیست یک به یک constraint ها را حذف کنیم.
همچنین کاربرد دیگر آن هنگامی است که یک layout که قبلا با استفاده از یک ViewGroup دیگر مانند LinearLayout طراحی شده را بخواهیم به ConstraintLayout تبدیل کنیم.

تبدیل ViewGroup های دیگر به ConstraintLayout

برای مثال قصد داریم رابط کاربری مربوط به آموزش دیتابیس در اندروید که قبلا با استفاده از RelativeLayout ساخته بودیم را به ConstraintLayout تبدیل کنیم. در قسمت Component Tree روی ViewGroup راست کلیک کرده و گزینه Convert RelativeLayout to ConstraintLayout را انتخاب می‌کنم:

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

ایجاد خودکار Constraint ها

گزینه Infer Constraints عملی متضاد با Clear All Constraints را انجام می‌دهد. واژه infer به معنی “حدس زدن” است. یعنی در یک layout از جنس ConstraintLayout که یک یا چندین ویجت بدون خطوط اتصال و مابقی قابلیت‌های آن اضافه شده، با کلیک روی این گزینه، اندروید استودیو به صورت حدسی تنظیمات و خطوط اتصال را برای آنها اعمال می‌کند اما همانطور که در قسمت قبل اشاره شد، این تنظیمات عموما رضایت بخش نبوده و در عمل کاربرد زیادی نخواهد داشت.
فعلا با ویجت دکمه کاری ندارم و آنرا از صفحه حذف می‌کنم.
یک گزینه دیگر با نام Default Margins در بالای صفحه Preview وجود دارد:

تعیین فاصله یا Margin پیش فرض

در طراحی یک layout برای ایجاد فاصله بین المان‌های مختلف از ویژگی Margin استفاده می‌کنیم. معمولا فاصله‌ای که در یک layout برای المان‌های مختلف استفاده می‌شود یکسان است تا چینش عناصر در رابط کاربری منظم و یکپارچه باشد.
مقدار Defalut Margin به طور پیش فرض روی عدد ۰ تنظیم شده. من این مقدار را روی ۱۶dp تنظیم می‌کنم و کار را ادامه می‌دهم.
ابتدا یک ImageView به صفحه اضافه می‌کنم:

در قسمت Attributes عرض این ویجت را ۰dp یا همان Match Constraint و ارتفاع را ۲۰۰dp تعیین می‌کنم. همچنین ویژگی scaleType را بر روی centerCrop تنظیم می‌کنم تا در هر اندازه‌ای از صفحه نمایش، تصویر به طور کامل در محل ImageView قرار گرفته و فضای خالی در اطراف آن ایجاد نشود:

سپس گره‌های سه جهت بالا و چپ و راست را به سه طرف والد یا به عبارتی لبه‌های صفحه نمایش متصل می‌کنم:

در تصویر بالا ملاحظه می‌کنید دو گره متصل شده یک فاصله ۱۶dp از لبه گرفته‌اند. قبلا این عدد را در Defalut Margin تعریف کرده بودیم. همچنین بعد از اینکه گره‌های بالا و سمت چپ را متصل کردم، به دلیل اینکه قبلا عرض تصویر به اندازه عرض صفحه پیش نمایش کشیده شده بود، گره سمت راست در داخل کادر قرار ندارد. اگر موس را بر روی خط چین سمت راست قرار داده و آنرا به سمت لبه راست صفحه بکشم خط اتصال برقرار می‌شود. یا اینکه در کادر Attributes در قسمت Constraint Widget روی نماد + سمت راست ویجت ImageView کلیک می‌کنم. اینجا فاصله ۱۶dp به طور خودکار اعمال نشد بنابراین به صورت دستی وارد می‌کنم. خروجی نهایی کار به اینصورت خواهد بود:

layout_two.xml

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout 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" >

    <ImageView
        android:id="@+id/imageView5"
        android:layout_width="0dp"
        android:layout_height="200dp"
        android:layout_marginStart="16dp"
        android:layout_marginLeft="16dp"
        android:layout_marginTop="16dp"
        android:layout_marginEnd="16dp"
        android:layout_marginRight="16dp"
        android:scaleType="centerCrop"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toTopOf="parent"
        app:srcCompat="@drawable/img_22" />

</androidx.constraintlayout.widget.ConstraintLayout>

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

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

کد این ویجت به اینصورت است:

<ImageView
    android:id="@+id/imageView6"
    android:layout_width="40dp"
    android:layout_height="40dp"
    android:background="#DFCD2E"
    android:padding="5dp"
    app:srcCompat="@android:drawable/stat_sys_speakerphone"
    tools:layout_editor_absoluteX="47dp"
    tools:layout_editor_absoluteY="244dp" />

حالا گره‌های بالا و پایین آیکون را به گره پایین ImageView قبلی متصل می‌کنم:

ملاحظه می‌کنید پس از انجام این کار، مرکز افقی تصویر دوم بر روی خط پایینی تصویر اول قرار گرفت. به همین سادگی!
در نهایت نود سمت چپ را هم به سمت چپ تصویر بزرگ متصل می‌کنم. با توجه به اینکه قبلا مقدار ۱۶dp را برای فاصله پیش فرض یا همان Default Margin تعیین کرده بودم، در اینجا نیز همین مقدار برای فاصله تعیین می‌شود:

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

layout_two.xml

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout 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">

    <ImageView
        android:id="@+id/imageView5"
        android:layout_width="0dp"
        android:layout_height="200dp"
        android:layout_marginStart="16dp"
        android:layout_marginLeft="16dp"
        android:layout_marginTop="16dp"
        android:layout_marginEnd="16dp"
        android:layout_marginRight="16dp"
        android:scaleType="centerCrop"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toTopOf="parent"
        app:srcCompat="@drawable/img_22" />

    <ImageView
        android:id="@+id/imageView6"
        android:layout_width="40dp"
        android:layout_height="40dp"
        android:layout_marginStart="16dp"
        android:layout_marginLeft="16dp"
        android:background="#DFCD2E"
        android:padding="5dp"
        app:layout_constraintBottom_toBottomOf="@+id/imageView5"
        app:layout_constraintStart_toStartOf="@+id/imageView5"
        app:layout_constraintTop_toBottomOf="@+id/imageView5"
        app:srcCompat="@android:drawable/stat_sys_speakerphone" />

</androidx.constraintlayout.widget.ConstraintLayout>

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

همتراز کردن ویجت‌های متنی توسط Baseline

یکی دیگر از قابلیت‌های بسیار کاربردی ConstraintLayout در ویجت‌های متنی مانند EditText و Button ها استفاده می‌شود و Baseline نام دارد. توسط این ویژگی به سادگی می‌توانیم دو ویجت را در راستای افقی در یک تراز قرار دهیم.
یک TextView و یک EditText به صفحه اضافه می‌کنم:

قابلیت Baseline بصورت پیش فرض روی ویجت‌ها فعال نیست و با راست کلیک روی آن و انتخاب گزینه Show Baseline فعال می‌گردد:

پس از انجام این کار یک قسمت کپسولی شکل به وسط EditText اضافه شد:

با کشیدن آن به سمت وسط ویجت TextView کپسول Baseline این ویجت نیز ظاهر می‌شود. بنابراین خطی که از Baseline ویجت EditText کشیده شده را روی آن رها می‌کنم:

حالا این دو ویجت در یک تراز قرار گرفته‌اند به طوری که متن درون EditText کاملا همراستای متن TextView دیده می‌شود. با تغییر موقعیت TextView ویجت EditText هم در همان جهت حرکت می‌کند و تراز باز هم برقرار باقی می‌ماند.
منابع تکمیلی: Developer ، Developer ، Developer ، Developer ، Developer ، Medium

جهت مطالعه ادامه آموزش، فایل PDF را دانلود نمائید

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

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

نوشته طراحی صفحات با ConstraintLayout + سورس پروژه اولین بار در اندروید استودیو پدیدار شد.

احتمالا با مشاهده تصویر بالا متوجه شده‌اید که در این مبحث می‌خواهیم راجع به چه موضوعی صحبت کنیم. بسته به میزان حجم یک پروژه اندرویدی، فرایند بیلد شدن آن بین چند ثانیه تا چندین دقیقه می‌تواند زمان بر باشد. بنابراین اجرای روش‌های افزایش سرعت بیلد 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 قرار دارد

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