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