Long parameter list: introduce a parameter object
Group the values that travel together, so a new one stops touching every signature.
Watch the narrated video
Every step
Problem
Steps 1–4Refactor
Steps 5–9Payoff
Steps 10–11Recap
Steps 12–13The code: before and after
Before
class ShippingService {
constructor(private readonly rates: RateTable) {}
quote(fromPostal: string, fromCountry: string,
toPostal: string, toCountry: string, weightKg: number,
lengthCm: number, widthCm: number, heightCm: number,
express: boolean): Quote {
const price = this.price(fromCountry, toCountry, weightKg,
lengthCm, widthCm, heightCm, express);
return { fromPostal, toPostal, price };
}
private price(fromCountry: string, toCountry: string,
weightKg: number, lengthCm: number,
widthCm: number, heightCm: number,
express: boolean): number {
const volumetricKg = lengthCm * widthCm * heightCm / 5000;
const cost = this.rates.perKg(fromCountry, toCountry)
* Math.max(weightKg, volumetricKg);
return express ? cost * 1.5 : cost;
}
}
const WAREHOUSE_POSTAL = "10115";
const WAREHOUSE_COUNTRY = "DE";
class Checkout {
constructor(private readonly shipping: ShippingService) {}
shippingFor(cart: Cart, customer: Customer): Quote {
return this.shipping.quote(WAREHOUSE_POSTAL, WAREHOUSE_COUNTRY,
customer.postalCode, customer.country, cart.weightKg,
cart.lengthCm, cart.widthCm, cart.heightCm,
cart.express);
}
}After
type Address = { postal: string; country: string };
type Parcel = { weightKg: number; lengthCm: number;
widthCm: number; heightCm: number; fragile: boolean };
function billableKg(parcel: Parcel): number {
const { weightKg, lengthCm, widthCm, heightCm } = parcel;
const volumetricKg = lengthCm * widthCm * heightCm / 5000;
return Math.max(weightKg, volumetricKg);
}
class ShippingService {
constructor(private readonly rates: RateTable) {}
quote(from: Address, to: Address, parcel: Parcel,
express: boolean): Quote {
const price = this.price(from, to, parcel, express);
return { fromPostal: from.postal, toPostal: to.postal, price };
}
private price(from: Address, to: Address, parcel: Parcel,
express: boolean): number {
const cost = this.rates.perKg(from.country, to.country)
* billableKg(parcel);
return (express ? cost * 1.5 : cost) * (parcel.fragile ? 1.2 : 1);
}
}
const WAREHOUSE_POSTAL = "10115";
const WAREHOUSE_COUNTRY = "DE";
class Checkout {
constructor(private readonly shipping: ShippingService) {}
shippingFor(cart: Cart, customer: Customer): Quote {
const from = { postal: WAREHOUSE_POSTAL, country: WAREHOUSE_COUNTRY };
const to = { postal: customer.postalCode, country: customer.country };
const parcel = { weightKg: cart.weightKg, lengthCm: cart.lengthCm,
widthCm: cart.widthCm, heightCm: cart.heightCm,
fragile: cart.fragile };
return this.shipping.quote(from, to, parcel, cart.express);
}
}Transcript, step by step
Problem
Step 1: A quote with nine parameters Before
At checkout, this method asks the shipping service for a quote. It passes the warehouse address from two constants, then the customer's address, then five values from the cart. The quote method takes all nine, and hands seven of them on to the price method. Price works out a volumetric weight from the box size, charges for whichever weight is larger, and adds half again for express.
Step 2: One flag, five edits Code smell
The carrier now charges twenty percent more for fragile parcels. Price needs a fragile flag, so the quote method, the call inside it and the checkout call all have to carry one there. A long parameter list is a method that takes so many values that every caller must line them up in the right order. You can see it here in the quote signature, here in the price signature, here in the call inside quote, and here in the checkout call. Quote uses two of its ten values itself, and the other eight pass straight through to price.
Step 3: Two booleans side by side Code smell
One new value cost four edits to signatures and calls before we reached the one line that uses it. And now express and fragile sit side by side as two booleans in every list. If someone swaps them, the strict compiler stays quiet, and the customer pays the wrong surcharge.
Step 4: Back it out, then group Plan
Let's back that change out and refactor first. Look at which values travel together, because the same groups show up in every list. The origin postal code and country always come as a pair, so do the destination's, and so do the weight and the three box sizes. A group like that is called a data clump, and Introduce Parameter Object turns each clump into one small type. We'll do it one clump at a time, and after each step the code compiles and the price comes out the same.
Refactor
Step 5: The origin becomes an Address Introduce Parameter Object
The origin comes first, so we add an Address type with a postal code and a country. Quote and price now take one Address called from, where they took two strings. Quote reads the postal code from it, and price reads the country. Checkout builds that address as an object literal from the two warehouse constants, and TypeScript checks its shape at the call.
Step 6: The destination is an Address too Introduce Parameter Object
The destination is the same kind of clump, so it reuses the same Address type. Both methods take from and to now, and the quote reads both postal codes off them. Checkout builds the second address from the customer.
Step 7: Four numbers become a Parcel Introduce Parameter Object
The last clump is the weight and the three box sizes, so they become a Parcel type. Four numbers leave both signatures, and quote takes four parameters where it took nine. Checkout builds the parcel from the cart, next to the two addresses. Price unpacks the parcel into four names, so the weight rule below it reads the same as before.
Step 8: Name the weight rule Extract Method
That weight rule deserves a name, so we extract it into a method called billable kg. Price multiplies the rate by billable kg, and no longer cares how that weight is worked out. But the new method reads four values from the parcel and never touches this, the shipping service.
Step 9: The rule moves next to Parcel Move Function
So it moves out of the class and sits right under the Parcel type, as a plain function. Parcel is a plain object type, so its rule lives in a function next to it, and price calls that function with the parcel. Quote and price take four parameters each now, and the call between them fits on one line.
Payoff
Step 10: Fragile, in three edits Payoff
Now the fragile surcharge goes back in. Fragile is a fact about the parcel, so it becomes one more field on Parcel. Checkout passes the cart's flag where it builds the parcel, and price adds the surcharge, so that's three edits, each where the value is made or used. The quote signature, the price signature and the call inside quote didn't change.
Step 11: Why the clumps paid off Payoff
Each data clump is one type now, so a new fact about the parcel joins Parcel, and quote, which only passes values on, stays the same. And the two booleans no longer sit side by side, because express is a parameter and fragile lives inside the parcel. Passing the whole cart and customer would look shorter, but the origin is warehouse constants, and the shipping service would then depend on checkout's types. Two addresses can still be swapped, though, and every parcel field is a plain number, so a length can land in the weight, which the next lesson on domain types takes care of.
Recap
Step 12: Where we started, where we ended Before / after
On the left, quote took nine parameters and handed seven of them on to price. Two country strings, four numbers and a boolean sat in a row, and any two of the numbers could trade places without the compiler noticing. On the right, two small object types hold the clumps, and the weight rule sits right next to the parcel. Quote and price take four parameters each, and fragile is already in.
Step 13: When to reach for it Takeaways
Reach for a parameter object when the same group of values goes through several methods in the same order. Skip it for a method with a few unrelated values, like a log call with a level, a message and an error, because a wrapper would group things that don't belong together. You'll spot it by the same names repeated across signatures, long runs of numbers or strings, and methods that only pass their parameters on. The built-in Intl number format already works this way, and takes one options object for the style and the currency.