Offline-Strategien für HTML5 Web Applikationen - bedcon13

Offline Strategien für
HTML5 Web Applikationen
Stephan Hochdörfer, bitExpert AG

Offline Strategien für HTML5 Web Applikationen

Über mich

 Stephan Hochdörfer

 Head of IT der bitExpert AG, Mannheim

 S.Hochdoerfer@bitExpert.de

 @shochdoerfer


[...] we take the next step,
announcing 2014 as the target for
Recommendation.
Jeff Jaffe, Chief Executive Officer, World Wide Web Consortium


Was bedeutet „offline“?



Applikation vs. Content



Application Cache vs. Offline Storage


App Cache für statische Ressourcen
HTML Page:
<!DOCTYPE html>
<html lang="en">


HTML Page:
<!DOCTYPE html>
<html lang="en" manifest="cache.manifest">

cache.manifest (Content-Type: text/cache-manifest):
CACHE MANIFEST

js/app.js
css/app.css
favicon.ico
http://someotherdomain.com/image.png


CACHE MANIFEST
# 20120916

NETWORK:
data.php

CACHE:
/main/home
/main/app.js
/settings/home
/settings/app.js
http://myhost/logo.png
http://myhost/check.png
http://myhost/cross.png


CACHE MANIFEST
# 20120916

FALLBACK:
/ /offline.html

NETWORK:
*


App Cache Scripting
// events fired by window.applicationCache
window.applicationCache.onchecking = function(e)
{log("Checking for updates");}
window.applicationCache.onnoupdate = function(e)
{log("No updates");}
window.applicationCache.onupdateready = function(e)
{log("Update ready");}
window.applicationCache.onobsolete = function(e)
{log("Obsolete");}
window.applicationCache.ondownloading = function(e)
{log("Downloading");}
window.applicationCache.oncached = function(e)
{log("Cached");}
window.applicationCache.onerror = function(e)
{log("Error");}

// Log each file
window.applicationCache.onprogress = function(e) {
log("Progress: downloaded file " + counter);
counter++;
};


App Cache Scripting
// Check if a new cache is available on page load.
window.addEventListener('load', function(e) {
  window.applicationCache.addEventListener('updateready',
  function(e) {

    if(window.applicationCache.status ==
        window.applicationCache.UPDATEREADY) {
      // Browser downloaded a new app cache.
      // Swap it in and reload the page
      window.applicationCache.swapCache();
      if (confirm('New version is available. Load it?)) {
        window.location.reload();
      }
    } else {
      // Manifest didn't change...
    }
  }, false);

}, false);


App Cache – Einige Fallstricke!



1. Dateien werden immer(!) vom
lokalen Cache ausgeliefert.



2. Der lokale Cache wird nur dann
aktualisiert wenn sich die manifest
Datei geändert hat.



3. Nicht ladbare Dateien aus der
CACHE Sektion führen dazu dass der
Cache invalide ist.



4. Kann die manifest Datei nicht
geladen werden, erfolgt kein Caching!



5. Nicht gecachte Ressourcen werden
auf einer gecachten Seite nicht
angezeigt.



6. Nach Aktualisierung des Caches
muss die Seite neu geladen werden!



7. Mit expires Header arbeiten um das
Cachen des manifests zu verhinden!


App Cache – Was darf gecacht werden?

Ja: Nein:

Schriften 
CSS

Startbild 
HTML

Applikationsicon 
Javascript

Einstiegsseite

Fallbackseite


App Cache – Was darf gecacht werden?

Den App Cache nur für
„statischen Content“ verwenden!


Data URI Schema


Data URI Schema
<!DOCTYPE HTML>
<html>
<head>
  <title>The Data URI scheme</title>
  <style type="text/css">
  ul.checklist li {
    marginleft: 20px;
    background: white
url('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAA
AFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAA
O9TXL0Y4OHwAAAABJRU5ErkJggg==') norepeat scroll left
top;
}
  </style>
</head>
<body>
  <img
src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAA
AFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAA
O9TXL0Y4OHwAAAABJRU5ErkJggg==" alt="Red dot">
</body>
</html>


Dynamische Daten lokal speichern...



Sourcen:
github.com/bitExpert/html5-offline



Web Storage, Web SQL Database,
IndexedDB, File API


Web Storage


Web Storage

Komfortable Art Daten offline zu
speichern: Key/Value Speicher


Web Storage: 2 Möglichkeiten

localStorage vs. sessionStorage


Web Storage: Datensatz hinzufügen
function add(item) {
try {
// for a new item set id
if((typeof item.id === "undefined")
             || (null == item.id) || ("" == item.id)) {
item.id = get_lastIndex() + 1;
}

// store object as string
localStorage.setItem(item.id,
             JSON.stringify(item)
         );

// update the index
set_lastIndex(item.id);
}
catch(ex) {
console.log(ex);
}
}


Web Storage: Datensatz ändern
function modify(item) {
try {
localStorage.setItem(item.id,
);
}
catch(ex) {
console.log(ex);
}
}


Web Storage: Datensatz löschen
function remove (id) {
try {
localStorage.removeItem(id);
}
catch(ex) {
console.log(ex);
}
}


Web Storage: Datensätze auslesen
function read() {
      try {
      var lastIdx = get_lastIndex();
      for(var i = 1; i <= lastIdx; i++) {
      if(null !== localStorage.getItem(i)) {
      // parse and render item
      var item = JSON.parse(
                        localStorage.getItem(i)
                   );
      }
      }
      }
      catch(ex) {
      console.log(ex);
      }
}


Web Storage: Wie sessionStorage nutzen?


Web Storage: Wie sessionStorage nutzen?

Ersetze „localStorage“
durch „sessionStorage“


Web Storage: Datensatz hinzufügen
try {
// for a new item set id
if((typeof item.id === "undefined")
             || (null == item.id) || ("" == item.id)) {
item.id = get_lastIndex() + 1;
}

sessionStorage.setItem(item.id,
         );

// update the index
set_lastIndex(item.id);
}
catch(ex) {
console.log(ex);
}
}


Web Storage: Alternative Zugriffsmöglichkeiten
var value = "my value";

// method call
localStorage.setItem("key", value);

// Array accessor
localStorage[key] = value;

// Property accessor
localStorage.key = value;


Web Storage: Vorteile

Die meisten der aktuellen Browser
„können“ Web Storage.


Web Storage: Nachteile

Daten werden unstrukturiert
gespeichert.



Nicht Transaktionsfähig!



Daten können nicht automatisch
verfallen. Manueller Aufwand nötig.



Unzureichende Informationen wie
voll der lokale Cache wirklich ist.


Web SQL Database


Web SQL Database

Eine lokale SQL Datenbank
auf SQLite Basis.


Web SQL Database: Callbacks
var onError = function(tx, ex) {
alert("Error: " + ex.message);
};

var onSuccess = function(tx, results) {
var len = results.rows.length;

for(var i = 0; i < len; i++) {
// render found todo item
render(results.rows.item(i));
}
};


Web SQL Database: Datenbank erzeugen
// initalize the database connection
var db = openDatabase('todo', '1.0', 'Todo Database',
   5 * 1024 * 1024 );

db.transaction(function (tx) {
tx.executeSql(
'CREATE TABLE IF NOT EXISTS todo '+
         '(id INTEGER PRIMARY KEY ASC, todo TEXT)',
[],
         onSuccess,
         onError
);
});


Web SQL Database: Datensatz hinzufügen
db.transaction(function(tx) {
tx.executeSql(
'INSERT INTO todo (todo) VALUES (?)',
[
item.todo
],
onSuccess,
onError
);
});
}


Web SQL Database: Datensatz verändern
db.transaction(function(tx) {
tx.executeSql(
'UPDATE todo SET todo = ? WHERE id = ?',
[
item.todo
item.id
],
onSuccess,
onError
);
});
}


Web SQL Database: Datensatz löschen
function remove(id) {
tx.executeSql(
'DELETE FROM todo WHERE id = ?',
[
id
],
onSuccess,
onError
);
});
}


Web SQL Database: Datensätze auslesen
function read() {
tx.executeSql(
'SELECT * FROM todo',
[],
onSuccess,
onError
);
});
}


Web SQL Database: Vorteile

Eine SQL Datenbank im Browser!


Web SQL Database: Nachteile

Eine SQL Datenbank im Browser!



SQLite kann seeeehr langsam sein!



Nicht länger Teil der
HTML5 Spezifikation!


IndexedDB


IndexedDB

Kompromiss aus Web Storage
und Web SQL Database.


Web SQL Database vs. IndexedDB
Kategorie Web SQL IndexedDB
Speicherart Tabellen mit Spalten und Objectstore mit Javascript Objekten und
Zeilen Keys
Abfrage SQL Cursor APIs, Key Range APIs und
mechanismus Applicationslogik
Transaktionali Lock für Databanken, Locks für Datenbanken
tät Tabellen oder Zeilen bei (VERSION_CHANGE Transaktion) und
READ_WRITE Transaktionen Objectstores (READ_ONLY, READ_WRITE
Transaktion).
Transaktions- Transaktionen werden explizt Transaktionen werden explizt erzeugt.
Commits erzeugt. Standard: Rollback, Standard: Committen sofern kein Fehler
außer es wird explizit ein aufgetreten ist.
commit ausgeführt.


IndexedDB: Vorarbeiten
// different browsers, different naming conventions
var indexedDB = window.indexedDB ||
   window.webkitIndexedDB || window.mozIndexedDB ||
   window.msIndexedDB;

var IDBTransaction = window.IDBTransaction ||
   window.webkitIDBTransaction;

var IDBKeyRange = window.IDBKeyRange ||
   window.webkitIDBKeyRange;


IndexedDB: Objektspeicher erzeugen
var db = null;
var request = indexedDB.open("todo");
request.onfailure = onError;
request.onsuccess = function(e) {
db = request.result;
var v = "1.0";
if(v != db.version) {
var verRequest = db.setVersion(v);
verRequest.onfailure = onError;
verRequest.onsuccess = function(e) {
var store = db.createObjectStore(
"todo",
{
keyPath: "id",
autoIncrement: true
}
);
e.target.transaction.oncomplete =
function() {};
};
}
};


IndexedDB: Datensatz hinzufügen
try {
var trans = db.transaction(["todo"],
IDBTransaction.READ_WRITE);

var store = trans.objectStore("todo");
var request = store.put({
"todo": item.todo,
});
}
catch(ex) {
onError(ex);
}
}


IndexedDB: Datensatz verändern
try {

var request = store.put(item);
}
catch(ex) {
onError(ex);
}
}


IndexedDB: Datensatz löschen
function remove(id) {
try {

var request = store.delete(id);
}
catch(ex) {
onError(ex);
}
}


IndexedDB: Datensätze auslesen
function read () {
try {
IDBTransaction.READ);

var keyRange = IDBKeyRange.lowerBound(0);
var cursorRequest = store.openCursor(keyRange);

cursorRequest.onsuccess = function(e) {
var result = e.target.result;
if(!!result == false) {
return;
}
// @TODO: render result.value
result.continue();
};
}
catch(ex) {
onError(ex);
}
}


IndexedDB: Vorteile

Neuer Standard der künftig durch
viele Browser unterstützt wird.


IndexedDB: Nachteile

Nur ein Index pro
Objektspeicher möglich.


File API


File API

FileReader API und FileWriter API


File API: Vorarbeiten
var onError = function(e) {
var msg = '';

switch(e.code) {
case FileError.QUOTA_EXCEEDED_ERR:
msg = 'QUOTA_EXCEEDED_ERR'; break;
case FileError.NOT_FOUND_ERR:
msg = 'NOT_FOUND_ERR'; break;
case FileError.SECURITY_ERR:
msg = 'SECURITY_ERR'; break;
case FileError.INVALID_MODIFICATION_ERR:
msg = 'INVALID_MODIFICATION_ERR'; break;
case FileError.INVALID_STATE_ERR:
msg = 'INVALID_STATE_ERR'; break;
default:
msg = 'Unknown Error'; break;
};

alert("Error: " + msg);
};


File API: Vorarbeiten II
// File system has been prefixed as of Google Chrome 12
window.requestFileSystem = window.requestFileSystem ||
window.webkitRequestFileSystem;

window.BlobBuilder = window.BlobBuilder ||
window.WebKitBlobBuilder;

var size = 5 * 1024*1024; // 5MB


File API: Quota anfordern
// request quota for persistent store
window.webkitStorageInfo.requestQuota(
PERSISTENT,
size,
function(grantedBytes) {
window.requestFileSystem(
PERSISTENT,
grantedBytes,
function(fs) {
// @TODO: access filesystem
}
}
}
}


File API: Daten hinzufügen
  PERSISTENT,
  size,
  PERSISTENT,
  grantedBytes,
  function(fs){
  writeToFile(fs, item);
  },
  onError
  );
  },
  function(e) {
  onError(e);
  }
  );
  },


File API: Daten hinzufügen II
function writeToFile(fs, item) {
fs.root.getFile(
'todo.txt',
{
create: true
},
function(fileEntry) {
fileEntry.createWriter(
function(fileWriter) {
var bb = new window.BlobBuilder();
bb.append(JSON.stringify(item)+
"n");

fileWriter.seek(fileWriter.length);
fileWriter.write(
bb.getBlob('text/plain'));
}, onError
);
}, onError
);
};


File API: Daten auslesen
function read() {
  PERSISTENT,
  size,
  PERSISTENT,
  grantedBytes,
  function(fs){
  readFromFile(fs);
  },
  onError
  );
  },
  function(e) {
  onError(e);
  }
  );
}


File API: Daten auslesen II
function readFromFile(fs) {
fs.root.getFile(
'todo.txt',
{
create: true
},
function(fileEntry) {
fileEntry.file(function(file){
var reader = new FileReader();
reader.onloadend = function(e) {
if (evt.target.readyState ==
FileReader.DONE) {
// process this.result
}
};
reader.readAsText(file);
});
}, onError
);
}


Bin ich online?


Bin ich online?
document.body.addEventListener("online", function () {
// browser is online!
}

document.body.addEventListener("offline", function () {
// browser is not online!
}


Bin ich online? Andere Vorgehensweise...
$.ajax({
  dataType: 'json',
  url: 'http://myappurl.com/ping',
  success: function(data){
    // ping worked
  },
  error: function() {
    // ping failed > Server not reachable
  }
});


Browserunterstützung?
App Cache Web Storage WebSQL IndexedDB File API Data URI
IE 10.0 8.0 10.0 10.0 - 8.0*
Firefox 11.0 11.0 11.0 11.0 19.0 16.0
Chrome 18.0 18.0 18.0 18.0 18.0 18.0
Safari 5.1 5.1 5.1 - - 5.1
Opera 12.1 12.1 12.1 - - 12.1
iOS Safari 3.2 3.2 3.2 - - 3.2
Android 2.1 2.1 2.1 - - 2.1

Quelle: http://caniuse.com


Speicherplatzbeschränkung?



Alle vorgestellten Technologien sind
durch Quotas beschränkt.


App Cache Web Storage WebSQL IndexedDB File API
iOS 5.1 10 MB 5 MB 5 MB 5 MB
Android 4 unlimited 5 MB ? ?
Safari 5.2 unlimited 5 MB 5 MB 5 MB
Chrome 18 5 MB 5 MB unlimited unlimited unlimited
IE 10 50 MB 10 MB 500 MB 500 MB
Opera 11 50 MB 5 MB 5 MB 5 MB
Firefox 11 unlimited 10 MB 50 MB 50 MB

Minimumwerte, je nach Konfiguration ist mehr möglich.

Offline-Strategien für HTML5 Web Applikationen - bedcon13

Weitere ähnliche Inhalte

Ähnlich wie Offline-Strategien für HTML5 Web Applikationen - bedcon13

Mehr von Stephan Hochdörfer

Offline-Strategien für HTML5 Web Applikationen - bedcon13