This post originated from an RSS feed registered with Agile Buzz
by Steven E. Newton.
Original Post: Why Web Services Matter
Feed Title: Crater Moon Buzz
Feed URL: http://www.cmdev.com/buzz/blosxom.cgi?flav=rss
Feed Description: Views and experiences from the software world.
"This notion of a specific contract is crucial to COM and to component software in general. Without "ironclad" contracts, it would be impossible to interchange components."
Distinguish between the public interface of a module, which can change as long as it's a within-team usage, and the published interface, which must be immutable and adhere to the contract.
"reuse [is] undervalued and insufficiently rewarded by the sponsoring organizations."
"Services are grouped into coherent, contractual units called ''interfaces''."
"By focusing on the notion of a contract, the service perspective introduces an important distinction between the specification of a component (what it does) and its implementation and executable forms (how it does it). This distinction is fundamental to the management of dependencies between components and begins to address the important requirement to be able to replace a component with minimal impact on the consumer, often referred to as "plug-and-play". "
Create detailed, well-defined interfaces. Java supports the interface explicitly.
Design-by-contract
When evolving the Component API from release to release, do not break existing Clients. API changes must not invalidate formerly legal client code.
Prevention steps for clients (callers)
Make method preconditions as strong as possible
Make method postconditions as weak as possible.
Ensure correct field invariants.
Settle on and do not change class/interface "gender"
Prefer creating a new interface to changing an existing one, even if the change does not break compatibility.
Define checked exception semantics carefully.
Publish (outside the team) APIs parsimoniously.
Evolutionary Changes
Deprecate and Forward
Create a new package
Any new methods that add/remove params, overload and call the old methods.
Communicating Changes
Clarify how APIs work when the spec is imprecise
Fix Broken Windows
Fix '''only''' Broken Windows
Note incompatible changes in the Release Notes
Component Infrastructure
Packaging
services-core jar file
Physical delivery m
1000
echanism? Dev Library
Version numbers on jar file or in manifest?
Distribution
Description of component
Web site
Browsable docs?
What sort of UML Diagrams?
What other StandUP artifacts, eg. Use Cases, should we have?
Building Systems from Pieces: Principles and Practice of Component-based Software Engineering by Alan W. Brown http://www.alanbrown.net/files/AWBChapter.zip
Public versus Published Interfaces http://www.martinfowler.com/articles/published.pdf, by Martin Fowler
Design By Contract http://archive.eiffel.com/doc/manuals/technology/contract/