Home | History | Annotate | Download | only in components
      1 page.title=Application Fundamentals
      2 @jd:body
      3 
      4 <div id="qv-wrapper">
      5 <div id="qv">
      6 
      7 <h2>In this document</h2>
      8 <ol>
      9 <li><a href="#Components">App Components</a>
     10   <ol>
     11     <li><a href="#ActivatingComponents">Activating components</a></li>
     12   </ol>
     13 </li>
     14 <li><a href="#Manifest">The Manifest File</a>
     15   <ol>
     16     <li><a href="#DeclaringComponents">Declaring components</a></li>
     17     <li><a href="#DeclaringRequirements">Declaring app requirements</a></li>
     18   </ol>
     19 </li>
     20 <li><a href="#Resources">App Resources</a></li>
     21 </ol>
     22 </div>
     23 </div>
     24 
     25 <p>Android apps are written in the Java programming language. The Android SDK tools compile
     26 your code&mdash;along with any data and resource files&mdash;into an APK: an <i>Android package</i>,
     27 which is an archive file with an {@code .apk} suffix. One APK file contains all the contents
     28 of an Android app and is the file that Android-powered devices use to install the app.</p>
     29 
     30 <p>Once installed on a device, each Android app lives in its own security sandbox: </p>
     31 
     32 <ul>
     33  <li>The Android operating system is a multi-user Linux system in which each app is a
     34 different user.</li>
     35 
     36 <li>By default, the system assigns each app a unique Linux user ID (the ID is used only by
     37 the system and is unknown to the app). The system sets permissions for all the files in an
     38 app so that only the user ID assigned to that app can access them. </li>
     39 
     40 <li>Each process has its own virtual machine (VM), so an app's code runs in isolation from
     41 other apps.</li>
     42 
     43 <li>By default, every app runs in its own Linux process. Android starts the process when any
     44 of the app's components need to be executed, then shuts down the process when it's no longer
     45 needed or when the system must recover memory for other apps.</li>
     46 </ul>
     47 
     48 <p>In this way, the Android system implements the <em>principle of least privilege</em>. That is,
     49 each app, by default, has access only to the components that it requires to do its work and
     50 no more. This creates a very secure environment in which an app cannot access parts of
     51 the system for which it is not given permission.</p>
     52 
     53 <p>However, there are ways for an app to share data with other apps and for an
     54 app to access system services:</p>
     55 
     56 <ul>
     57   <li>It's possible to arrange for two apps to share the same Linux user ID, in which case
     58 they are able to access each other's files.  To conserve system resources, apps with the
     59 same user ID can also arrange to run in the same Linux process and share the same VM (the
     60 apps must also be signed with the same certificate).</li>
     61   <li>An app can request permission to access device data such as the user's
     62 contacts, SMS messages, the mountable storage (SD card), camera, Bluetooth, and more. All
     63 app permissions must be granted by the user at install time.</li>
     64 </ul>
     65 
     66 <p>That covers the basics regarding how an Android app exists within the system. The rest of
     67 this document introduces you to:</p>
     68 <ul>
     69   <li>The core framework components that define your app.</li>
     70   <li>The manifest file in which you declare components and required device features for your
     71 app.</li>
     72   <li>Resources that are separate from the app code and allow your app to
     73 gracefully optimize its behavior for a variety of device configurations.</li>
     74 </ul>
     75 
     76 
     77 
     78 <h2 id="Components">App Components</h2>
     79 
     80 <p>App components are the essential building blocks of an Android app. Each
     81 component is a different point through which the system can enter your app. Not all
     82 components are actual entry points for the user and some depend on each other, but each one exists
     83 as its own entity and plays a specific role&mdash;each one is a unique building block that
     84 helps define your app's overall behavior.</p>
     85 
     86 <p>There are four different types of app components. Each type serves a distinct purpose
     87 and has a distinct lifecycle that defines how the component is created and destroyed.</p>
     88 
     89 <p>Here are the four types of app components:</p>
     90 
     91 <dl>
     92 
     93 <dt><b>Activities</b></dt>
     94 
     95 <dd>An <i>activity</i> represents a single screen with a user interface. For example,
     96 an email app might have one activity that shows a list of new
     97 emails, another activity to compose an email, and another activity for reading emails. Although
     98 the activities work together to form a cohesive user experience in the email app, each one
     99 is independent of the others. As such, a different app can start any one of these
    100 activities (if the email app allows it). For example, a camera app can start the
    101 activity in the email app that composes new mail, in order for the user to share a picture.
    102 
    103 <p>An activity is implemented as a subclass of {@link android.app.Activity} and you can learn more
    104 about it in the <a href="{@docRoot}guide/components/activities.html">Activities</a>
    105 developer guide.</p>
    106 </dd>
    107 
    108 
    109 <dt><b>Services</b></dt>
    110 
    111 <dd>A <i>service</i> is a component that runs in the background to perform long-running
    112 operations or to perform work for remote processes. A service
    113 does not provide a user interface. For example, a service might play music in the background while
    114 the user is in a different app, or it might fetch data over the network without
    115 blocking user interaction with an activity. Another component, such as an activity, can start the
    116 service and let it run or bind to it in order to interact with it.
    117 
    118 <p>A service is implemented as a subclass of {@link android.app.Service} and you can learn more
    119 about it in the <a href="{@docRoot}guide/components/services.html">Services</a> developer
    120 guide.</p>
    121 </dd>
    122 
    123 
    124 <dt><b>Content providers</b></dt>
    125 
    126 <dd>A <i>content provider</i> manages a shared set of app data. You can store the data in
    127 the file system, an SQLite database, on the web, or any other persistent storage location your
    128 app can access. Through the content provider, other apps can query or even modify
    129 the data (if the content provider allows it). For example, the Android system provides a content
    130 provider that manages the user's contact information. As such, any app with the proper
    131 permissions can query part of the content provider (such as {@link
    132 android.provider.ContactsContract.Data}) to read and write information about a particular person.
    133 
    134 <p>Content providers are also useful for reading and writing data that is private to your
    135 app and not shared. For example, the <a
    136 href="{@docRoot}resources/samples/NotePad/index.html">Note Pad</a> sample app uses a
    137 content provider to save notes.</p>
    138 
    139 <p>A content provider is implemented as a subclass of {@link android.content.ContentProvider}
    140 and must implement a standard set of APIs that enable other apps to perform
    141 transactions. For more information, see the <a
    142 href="{@docRoot}guide/topics/providers/content-providers.html">Content Providers</a> developer
    143 guide.</p>
    144 </dd>
    145 
    146 
    147 <dt><b>Broadcast receivers</b></dt>
    148 
    149 <dd>A <i>broadcast receiver</i> is a component that responds to system-wide broadcast
    150 announcements.  Many broadcasts originate from the system&mdash;for example, a broadcast announcing
    151 that the screen has turned off, the battery is low, or a picture was captured.
    152 Apps can also initiate broadcasts&mdash;for example, to let other apps know that
    153 some data has been downloaded to the device and is available for them to use. Although broadcast
    154 receivers don't display a user interface, they may <a
    155 href="{@docRoot}guide/topics/ui/notifiers/notifications.html">create a status bar notification</a>
    156 to alert the user when a broadcast event occurs. More commonly, though, a broadcast receiver is
    157 just a "gateway" to other components and is intended to do a very minimal amount of work. For
    158 instance, it might initiate a service to perform some work based on the event.
    159 
    160 <p>A broadcast receiver is implemented as a subclass of {@link android.content.BroadcastReceiver}
    161 and each broadcast is delivered as an {@link android.content.Intent} object. For more information,
    162 see the {@link android.content.BroadcastReceiver} class.</p>
    163 </dd>
    164 
    165 </dl>
    166 
    167 
    168 
    169 <p>A unique aspect of the Android system design is that any app can start another
    170 apps component. For example, if you want the user to capture a
    171 photo with the device camera, there's probably another app that does that and your
    172 app can use it, instead of developing an activity to capture a photo yourself. You don't
    173 need to incorporate or even link to the code from the camera app.
    174 Instead, you can simply start the activity in the camera app that captures a
    175 photo. When complete, the photo is even returned to your app so you can use it. To the user,
    176 it seems as if the camera is actually a part of your app.</p>
    177 
    178 <p>When the system starts a component, it starts the process for that app (if it's not
    179 already running) and instantiates the classes needed for the component. For example, if your
    180 app starts the activity in the camera app that captures a photo, that activity
    181 runs in the process that belongs to the camera app, not in your app's process.
    182 Therefore, unlike apps on most other systems, Android apps don't have a single entry
    183 point (there's no {@code main()} function, for example).</p>
    184 
    185 <p>Because the system runs each app in a separate process with file permissions that
    186 restrict access to other apps, your app cannot directly activate a component from
    187 another app. The Android system, however, can. So, to activate a component in
    188 another app, you must deliver a message to the system that specifies your <em>intent</em> to
    189 start a particular component. The system then activates the component for you.</p>
    190 
    191 
    192 <h3 id="ActivatingComponents">Activating Components</h3>
    193 
    194 <p>Three of the four component types&mdash;activities, services, and
    195 broadcast receivers&mdash;are activated by an asynchronous message called an <em>intent</em>.
    196 Intents bind individual components to each other at runtime (you can think of them
    197 as the messengers that request an action from other components), whether the component belongs
    198 to your app or another.</p>
    199 
    200 <p>An intent is created with an {@link android.content.Intent} object, which defines a message to
    201 activate either a specific component or a specific <em>type</em> of component&mdash;an intent
    202 can be either explicit or implicit, respectively.</p>
    203 
    204 <p>For activities and services, an intent defines the action to perform (for example, to "view" or
    205 "send" something) and may specify the URI of the data to act on (among other things that the
    206 component being started might need to know). For example, an intent might convey a request for an
    207 activity to show an image or to open a web page. In some cases, you can start an
    208 activity to receive a result, in which case, the activity also returns
    209 the result in an {@link android.content.Intent} (for example, you can issue an intent to let
    210 the user pick a personal contact and have it returned to you&mdash;the return intent includes a
    211 URI pointing to the chosen contact).</p>
    212 
    213 <p>For broadcast receivers, the intent simply defines the
    214 announcement being broadcast (for example, a broadcast to indicate the device battery is low
    215 includes only a known action string that indicates "battery is low").</p>
    216 
    217 <p>The other component type, content provider, is not activated by intents. Rather, it is
    218 activated when targeted by a request from a {@link android.content.ContentResolver}. The content
    219 resolver handles all direct transactions with the content provider so that the component that's
    220 performing transactions with the provider doesn't need to and instead calls methods on the {@link
    221 android.content.ContentResolver} object. This leaves a layer of abstraction between the content
    222 provider and the component requesting information (for security).</p>
    223 
    224 <p>There are separate methods for activating each type of component:</p>
    225 <ul>
    226   <li>You can start an activity (or give it something new to do) by
    227 passing an {@link android.content.Intent} to {@link android.content.Context#startActivity
    228 startActivity()} or {@link android.app.Activity#startActivityForResult startActivityForResult()}
    229 (when you want the activity to return a result).</li>
    230   <li>You can start a service (or give new instructions to an ongoing service) by
    231 passing an {@link android.content.Intent} to {@link android.content.Context#startService
    232 startService()}. Or you can bind to the service by passing an {@link android.content.Intent} to
    233 {@link android.content.Context#bindService bindService()}.</li>
    234   <li>You can initiate a broadcast by passing an {@link android.content.Intent} to methods like
    235 {@link android.content.Context#sendBroadcast(Intent) sendBroadcast()}, {@link
    236 android.content.Context#sendOrderedBroadcast(Intent, String) sendOrderedBroadcast()}, or {@link
    237 android.content.Context#sendStickyBroadcast sendStickyBroadcast()}.</li>
    238   <li>You can perform a query to a content provider by calling {@link
    239 android.content.ContentProvider#query query()} on a {@link android.content.ContentResolver}.</li>
    240 </ul>
    241 
    242 <p>For more information about using intents, see the <a
    243 href="{@docRoot}guide/components/intents-filters.html">Intents and
    244 Intent Filters</a> document. More information about activating specific components is also provided
    245 in the following documents: <a
    246 href="{@docRoot}guide/components/activities.html">Activities</a>, <a
    247 href="{@docRoot}guide/components/services.html">Services</a>, {@link
    248 android.content.BroadcastReceiver} and <a
    249 href="{@docRoot}guide/topics/providers/content-providers.html">Content Providers</a>.</p>
    250 
    251 
    252 <h2 id="Manifest">The Manifest File</h2>
    253 
    254 <p>Before the Android system can start an app component, the system must know that the
    255 component exists by reading the app's {@code AndroidManifest.xml} file (the "manifest"
    256 file). Your app must declare all its components in this file, which must be at the root of
    257 the app project directory.</p>
    258 
    259 <p>The manifest does a number of things in addition to declaring the app's components,
    260 such as:</p>
    261 <ul>
    262   <li>Identify any user permissions the app requires, such as Internet access or
    263 read-access to the user's contacts.</li>
    264   <li>Declare the minimum <a href="{@docRoot}guide/topics/manifest/uses-sdk-element.html#ApiLevels">API Level</a>
    265 required by the app, based on which APIs the app uses.</li>
    266   <li>Declare hardware and software features used or required by the app, such as a camera,
    267 bluetooth services, or a multitouch screen.</li>
    268   <li>API libraries the app needs to be linked against (other than the Android framework
    269 APIs), such as the <a
    270 href="http://code.google.com/android/add-ons/google-apis/maps-overview.html">Google Maps
    271 library</a>.</li>
    272   <li>And more</li>
    273 </ul>
    274 
    275 
    276 <h3 id="DeclaringComponents">Declaring components</h3>
    277 
    278 <p>The primary task of the manifest is to inform the system about the app's components. For
    279 example, a manifest file can declare an activity as follows: </p>
    280 
    281 <pre>
    282 &lt;?xml version="1.0" encoding="utf-8"?&gt;
    283 &lt;manifest ... &gt;
    284     &lt;application android:icon="@drawable/app_icon.png" ... &gt;
    285         &lt;activity android:name="com.example.project.ExampleActivity"
    286                   android:label="@string/example_label" ... &gt;
    287         &lt;/activity&gt;
    288         ...
    289     &lt;/application&gt;
    290 &lt;/manifest&gt;</pre>
    291 
    292 <p>In the <code><a
    293 href="{@docRoot}guide/topics/manifest/application-element.html">&lt;application&gt;</a></code>
    294 element, the {@code android:icon} attribute points to resources for an icon that identifies the
    295 app.</p>
    296 
    297 <p>In the <code><a
    298 href="{@docRoot}guide/topics/manifest/activity-element.html">&lt;activity&gt;</a></code> element,
    299 the {@code android:name} attribute specifies the fully qualified class name of the {@link
    300 android.app.Activity} subclass and the {@code android:label} attributes specifies a string
    301 to use as the user-visible label for the activity.</p>
    302 
    303 <p>You must declare all app components this way:</p>
    304 <ul>
    305   <li><code><a
    306 href="{@docRoot}guide/topics/manifest/activity-element.html">&lt;activity&gt;</a></code> elements
    307 for activities</li>
    308   <li><code><a
    309 href="{@docRoot}guide/topics/manifest/service-element.html">&lt;service&gt;</a></code> elements for
    310 services</li>
    311   <li><code><a
    312 href="{@docRoot}guide/topics/manifest/receiver-element.html">&lt;receiver&gt;</a></code> elements
    313 for broadcast receivers</li>
    314   <li><code><a
    315 href="{@docRoot}guide/topics/manifest/provider-element.html">&lt;provider&gt;</a></code> elements
    316 for content providers</li>
    317 </ul>
    318 
    319 <p>Activities, services, and content providers that you include in your source but do not declare
    320 in the manifest are not visible to the system and, consequently, can never run.  However,
    321 broadcast
    322 receivers can be either declared in the manifest or created dynamically in code (as
    323 {@link android.content.BroadcastReceiver} objects) and registered with the system by calling
    324 {@link android.content.Context#registerReceiver registerReceiver()}.</p>
    325 
    326 <p>For more about how to structure the manifest file for your app, see <a
    327 href="{@docRoot}guide/topics/manifest/manifest-intro.html">The AndroidManifest.xml File</a>
    328 documentation. </p>
    329 
    330 
    331 
    332 <h3 id="DeclaringComponentCapabilities">Declaring component capabilities</h3>
    333 
    334 <p>As discussed above, in <a href="#ActivatingComponents">Activating Components</a>, you can use an
    335 {@link android.content.Intent} to start activities, services, and broadcast receivers. You can do so
    336 by explicitly naming the target component (using the component class name) in the intent. However,
    337 the real power of intents lies in the concept of <em>implicit intents</em>. An implicit intent
    338 simply describes the type of action to perform (and, optionally, the data upon which youd like to
    339 perform the action) and allows the system to find a component on the device that can perform the
    340 action and start it. If there are multiple components that can perform the action described by the
    341 intent, then the user selects which one to use.</p>
    342 
    343 <p>The way the system identifies the components that can respond to an intent is by comparing the
    344 intent received to the <i>intent filters</i> provided in the manifest file of other apps on
    345 the device.</p>
    346 
    347 <p>When you declare an activity in your app's manifest, you can optionally include
    348 intent filters that declare the capabilities of the activity so it can respond to intents
    349 from other apps. You can declare an intent filter for your component by
    350 adding an <a href="{@docRoot}guide/topics/manifest/intent-filter-element.html">{@code
    351 &lt;intent-filter&gt;}</a> element as a child of the component's declaration element.</p>
    352 
    353 <p>For example, if you've built an email app with an activity for composing a new email, you can
    354 declare an intent filter to respond to "send" intents (in order to send a new email) like this:</p>
    355 <pre>
    356 &lt;manifest ... >
    357     ...
    358     &lt;application ... &gt;
    359         &lt;activity android:name="com.example.project.ComposeEmailActivity">
    360             &lt;intent-filter>
    361                 &lt;action android:name="android.intent.action.SEND" />
    362                 &lt;data android:type="*/*" />
    363                 &lt;category android:name="android.intent.category.DEFAULT" />
    364             &lt;/intent-filter>
    365         &lt;/activity>
    366     &lt;/application&gt;
    367 &lt;/manifest>
    368 </pre>
    369 
    370 <p>Then, if another app creates an intent with the {@link
    371 android.content.Intent#ACTION_SEND} action and pass it to {@link android.app.Activity#startActivity
    372 startActivity()}, the system may start your activity so the user can draft and send an
    373 email.</p>
    374 
    375 <p>For more about creating intent filters, see the <a
    376 href="{@docRoot}guide/components/intents-filters.html">Intents and Intent Filters</a> document.
    377 </p>
    378 
    379 
    380 
    381 <h3 id="DeclaringRequirements">Declaring app requirements</h3>
    382 
    383 <p>There are a variety of devices powered by Android and not all of them provide the
    384 same features and capabilities. In order to prevent your app from being installed on devices
    385 that lack features needed by your app, it's important that you clearly define a profile for
    386 the types of devices your app supports by declaring device and software requirements in your
    387 manifest file. Most of these declarations are informational only and the system does not read
    388 them, but external services such as Google Play do read them in order to provide filtering
    389 for users when they search for apps from their device.</p>
    390 
    391 <p>For example, if your app requires a camera and uses APIs introduced in Android 2.1 (<a
    392 href="{@docRoot}guide/topics/manifest/uses-sdk-element.html#ApiLevels">API Level</a> 7),
    393 you should declare these as requirements in your manifest file like this:</p> 
    394 
    395 <pre>
    396 &lt;manifest ... >
    397     &lt;uses-feature android:name="android.hardware.camera.any"
    398                   android:required="true" />
    399     &lt;uses-sdk android:minSdkVersion="7" android:targetSdkVersion="19" />
    400     ...
    401 &lt;/manifest>
    402 </pre>
    403 
    404 <p>Now, devices that do <em>not</em> have a camera and have an
    405 Android version <em>lower</em> than 2.1 cannot install your app from Google Play.</p>
    406 
    407 <p>However, you can also declare that your app uses the camera, but does not
    408 <em>require</em> it. In that case, your app must set the <a href=
    409 "{@docRoot}guide/topics/manifest/uses-feature-element.html#required">{@code required}</a>
    410 attribute to {@code "false"} and check at runtime whether
    411 the device has a camera and disable any camera features as appropriate.</p>
    412 
    413 <p>More information about how you can manage your app's compatibility with different devices
    414 is provided in the <a href="{@docRoot}guide/practices/compatibility.html">Device Compatibility</a>
    415 document.</p>
    416 
    417 
    418 
    419 <h2 id="Resources">App Resources</h2>
    420 
    421 <p>An Android app is composed of more than just code&mdash;it requires resources that are
    422 separate from the source code, such as images, audio files, and anything relating to the visual
    423 presentation of the app. For example, you should define animations, menus, styles, colors,
    424 and the layout of activity user interfaces with XML files. Using app resources makes it easy
    425 to update various characteristics of your app without modifying code and&mdash;by providing
    426 sets of alternative resources&mdash;enables you to optimize your app for a  variety of
    427 device configurations (such as different languages and screen sizes).</p>
    428 
    429 <p>For every resource that you include in your Android project, the SDK build tools define a unique
    430 integer ID, which you can use to reference the resource from your app code or from
    431 other resources defined in XML. For example, if your app contains an image file named {@code
    432 logo.png} (saved in the {@code res/drawable/} directory), the SDK tools generate a resource ID
    433 named {@code R.drawable.logo}, which you can use to reference the image and insert it in your
    434 user interface.</p>
    435 
    436 <p>One of the most important aspects of providing resources separate from your source code
    437 is the ability for you to provide alternative resources for different device
    438 configurations. For example, by defining UI strings in XML, you can translate the strings into other
    439 languages and save those strings in separate files. Then, based on a language <em>qualifier</em>
    440 that you append to the resource directory's name (such as {@code res/values-fr/} for French string
    441 values) and the user's language setting, the Android system applies the appropriate language strings
    442 to your UI.</p>
    443 
    444 <p>Android supports many different <em>qualifiers</em> for your alternative resources. The
    445 qualifier is a short string that you include in the name of your resource directories in order to
    446 define the device configuration for which those resources should be used. As another
    447 example, you should often create different layouts for your activities, depending on the
    448 device's screen orientation and size. For example, when the device screen is in portrait
    449 orientation (tall), you might want a layout with buttons to be vertical, but when the screen is in
    450 landscape orientation (wide), the buttons should be aligned horizontally. To change the layout
    451 depending on the orientation, you can define two different layouts and apply the appropriate
    452 qualifier to each layout's directory name. Then, the system automatically applies the appropriate
    453 layout depending on the current device orientation.</p>
    454 
    455 <p>For more about the different kinds of resources you can include in your application and how to
    456 create alternative resources for different device configurations, read <a href=
    457 "{@docRoot}guide/topics/resources/providing-resources.html">Providing Resources</a>.</p>
    458 
    459 
    460 
    461 <div class="next-docs">
    462 <div class="col-6">
    463   <h2 class="norule">Continue reading about:</h2>
    464   <dl>
    465     <dt><a href="{@docRoot}guide/components/intents-filters.html">Intents and Intent Filters</a>
    466     </dt>
    467     <dd>Information about how to use the {@link android.content.Intent} APIs to
    468     activate app components, such as activities and services, and how to make your app components
    469     available for use by other apps.</dd>
    470     <dt><a href="{@docRoot}guide/components/activities.html">Activities</a></dt>
    471     <dd>Information about how to create an instance of the {@link android.app.Activity} class,
    472     which provides a distinct screen in your application with a user interface.</dd>
    473     <dt><a
    474 href="{@docRoot}guide/topics/resources/providing-resources.html">Providing Resources</a></dt>
    475     <dd>Information about how Android apps are structured to separate app resources from the
    476    app code, including how you can provide alternative resources for specific device
    477    configurations.
    478     </dd>
    479   </dl>
    480 </div>
    481 <div class="col-6">
    482   <h2 class="norule">You might also be interested in:</h2>
    483   <dl>
    484     <dt><a href="{@docRoot}guide/practices/compatibility.html"
    485         >Device Compatibility</a></dt>
    486     <dd>Information about Android works on different types of devices and an introduction
    487     to how you can optimize your app for each device or restrict your app's availability
    488     to different devices.</dd>
    489     <dt><a href="{@docRoot}guide/topics/security/permissions.html"
    490         >System Permissions</a></dt>
    491     <dd>Information about how Android restricts app access to certain APIs with a permission
    492     system that requires the user's consent for your app to use those APIs.</dd>
    493   </dl>
    494 </div>
    495 </div>
    496 
    497