stefanoj3 /
dirstalk
| Conditions | 15 |
| Total Lines | 71 |
| Code Lines | 45 |
| Lines | 0 |
| Ratio | 0 % |
| Changes | 0 | ||
Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.
For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.
Commonly applied refactorings include:
If many parameters/temporary variables are present:
Complex classes like client.NewClientFromConfig often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
Methods with many parameters are not only hard to understand, but their parameters also often become inconsistent when you need more, or different data.
There are several approaches to avoid long parameter lists:
| 1 | package client |
||
| 17 | func NewClientFromConfig( |
||
| 18 | timeoutInMilliseconds int, |
||
| 19 | socks5Url *url.URL, |
||
| 20 | userAgent string, |
||
| 21 | useCookieJar bool, |
||
| 22 | cookies []*http.Cookie, |
||
| 23 | headers map[string]string, |
||
| 24 | shouldCacheRequests bool, |
||
| 25 | shouldSkipSSLCertificatesValidation bool, |
||
| 26 | u *url.URL, |
||
| 27 | ) (*http.Client, error) { |
||
| 28 | transport := buildTransport(shouldSkipSSLCertificatesValidation) |
||
| 29 | |||
| 30 | c := &http.Client{ |
||
| 31 | Timeout: time.Millisecond * time.Duration(timeoutInMilliseconds), |
||
| 32 | Transport: transport, |
||
| 33 | CheckRedirect: func(req *http.Request, via []*http.Request) error { |
||
| 34 | return http.ErrUseLastResponse |
||
| 35 | }, |
||
| 36 | } |
||
| 37 | |||
| 38 | if useCookieJar { |
||
| 39 | jar, err := cookiejar.New(nil) |
||
| 40 | if err != nil { |
||
| 41 | return nil, errors.Wrap(err, "NewClientFromConfig: failed to create cookie jar") |
||
| 42 | } |
||
| 43 | |||
| 44 | c.Jar = jar |
||
| 45 | } |
||
| 46 | |||
| 47 | if c.Jar != nil { |
||
| 48 | c.Jar.SetCookies(u, cookies) |
||
| 49 | } |
||
| 50 | |||
| 51 | if len(cookies) > 0 && c.Jar == nil { |
||
| 52 | c.Jar = cookie.NewStatelessJar(cookies) |
||
| 53 | } |
||
| 54 | |||
| 55 | if socks5Url != nil { |
||
| 56 | tbDialer, err := proxy.FromURL(socks5Url, proxy.Direct) |
||
| 57 | if err != nil { |
||
| 58 | return nil, errors.Wrap(err, "NewClientFromConfig: failed to create socks5 proxy") |
||
| 59 | } |
||
| 60 | |||
| 61 | transport.DialContext = func(ctx context.Context, network, addr string) (conn net.Conn, e error) { |
||
| 62 | return tbDialer.Dial(network, addr) |
||
| 63 | } |
||
| 64 | } |
||
| 65 | |||
| 66 | var err error |
||
| 67 | |||
| 68 | c.Transport, err = decorateTransportWithUserAgentDecorator(c.Transport, userAgent) |
||
| 69 | if err != nil { |
||
| 70 | return nil, errors.Wrap(err, "NewClientFromConfig: failed to decorate transport") |
||
| 71 | } |
||
| 72 | |||
| 73 | if len(headers) > 0 { |
||
| 74 | c.Transport, err = decorateTransportWithHeadersDecorator(c.Transport, headers) |
||
| 75 | if err != nil { |
||
| 76 | return nil, errors.Wrap(err, "NewClientFromConfig: failed to decorate transport") |
||
| 77 | } |
||
| 78 | } |
||
| 79 | |||
| 80 | if shouldCacheRequests { |
||
| 81 | c.Transport, err = decorateTransportWithRequestCacheDecorator(c.Transport) |
||
| 82 | if err != nil { |
||
| 83 | return nil, errors.Wrap(err, "NewClientFromConfig: failed to decorate transport") |
||
| 84 | } |
||
| 85 | } |
||
| 86 | |||
| 87 | return c, nil |
||
| 88 | } |
||
| 105 |
